{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/communication:sendgrid-webhooks-v3/create-event-webhook":{"post":{"operationId":"communication_sendgrid_webhooks_v3_create_event_webhook","summary":"Create a new Event Webhook","description":"POST /v3/user/webhooks/event/settings","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-webhooks-v3/list-event-webhook":{"get":{"operationId":"communication_sendgrid_webhooks_v3_list_event_webhook","summary":"Retrieve all of your Event Webhooks.","description":"GET /v3/user/webhooks/event/settings/all","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…","schema":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}},{"name":"include","in":"query","required":false,"description":"Use this to include optional fields in the response payload. When this is set to `include=account_status_change`, the…","schema":{"type":"string","description":"Use this to include optional fields in the response payload. When this is set to `include=account_status_change`, the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-webhooks-v3/get-signed-event-webhook":{"get":{"operationId":"communication_sendgrid_webhooks_v3_get_signed_event_webhook","summary":"Get Signed Event Webhook's Public Key","description":"GET /v3/user/webhooks/event/settings/signed/{id}","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…","schema":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}},{"name":"id","in":"query","required":true,"description":"The ID of the Event Webhook you want to retrieve.","schema":{"type":"string","description":"The ID of the Event Webhook you want to retrieve."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-webhooks-v3/update-signed-event-webhook":{"post":{"operationId":"communication_sendgrid_webhooks_v3_update_signed_event_webhook","summary":"Toggle signature verification for a single Event Webhook by ID","description":"PATCH /v3/user/webhooks/event/settings/signed/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"},"id":{"type":"string","description":"The ID of the Event Webhook you want to retrieve."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-webhooks-v3/test-event-webhook":{"post":{"operationId":"communication_sendgrid_webhooks_v3_test_event_webhook","summary":"Test an Event Webhook's settings","description":"POST /v3/user/webhooks/event/test","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-webhooks-v3/get-event-webhook":{"get":{"operationId":"communication_sendgrid_webhooks_v3_get_event_webhook","summary":"Get the settings for a single Event Webhook.","description":"GET /v3/user/webhooks/event/settings/{id}","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…","schema":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}},{"name":"id","in":"query","required":true,"description":"The ID of the Event Webhook you want to retrieve.","schema":{"type":"string","description":"The ID of the Event Webhook you want to retrieve."}},{"name":"include","in":"query","required":false,"description":"Use this to include optional fields in the response payload. When this is set to `include=account_status_change`, the…","schema":{"type":"string","description":"Use this to include optional fields in the response payload. When this is set to `include=account_status_change`, the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-webhooks-v3/update-event-webhook":{"post":{"operationId":"communication_sendgrid_webhooks_v3_update_event_webhook","summary":"Update a single Event Webhook by ID.","description":"PATCH /v3/user/webhooks/event/settings/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"},"id":{"type":"string","description":"The ID of the Event Webhook you want to retrieve."},"include":{"type":"string","description":"Use this to include optional fields in the response payload. When this is set to `include=account_status_change`, the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-webhooks-v3/delete-event-webhook":{"post":{"operationId":"communication_sendgrid_webhooks_v3_delete_event_webhook","summary":"Delete a single Event Webhook by ID.","description":"DELETE /v3/user/webhooks/event/settings/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"},"id":{"type":"string","description":"The ID of the Event Webhook you want to retrieve."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-webhooks-v3/list-parse-setting":{"get":{"operationId":"communication_sendgrid_webhooks_v3_list_parse_setting","summary":"Retrieve all parse settings","description":"GET /v3/user/webhooks/parse/settings","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…","schema":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-webhooks-v3/create-parse-setting":{"post":{"operationId":"communication_sendgrid_webhooks_v3_create_parse_setting","summary":"Create a parse setting","description":"POST /v3/user/webhooks/parse/settings","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-webhooks-v3/get-parse-setting":{"get":{"operationId":"communication_sendgrid_webhooks_v3_get_parse_setting","summary":"Retrieve a specific parse setting","description":"GET /v3/user/webhooks/parse/settings/{hostname}","tags":["communication"],"parameters":[{"name":"hostname","in":"query","required":true,"description":"The hostname associated with the inbound parse setting that you would like to retrieve.","schema":{"type":"string","description":"The hostname associated with the inbound parse setting that you would like to retrieve."}},{"name":"on-behalf-of","in":"query","required":false,"description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…","schema":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-webhooks-v3/update-parse-setting":{"post":{"operationId":"communication_sendgrid_webhooks_v3_update_parse_setting","summary":"Update a parse setting","description":"PATCH /v3/user/webhooks/parse/settings/{hostname}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["hostname"],"properties":{"hostname":{"type":"string","description":"The hostname associated with the inbound parse setting that you would like to retrieve."},"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-webhooks-v3/delete-parse-setting":{"post":{"operationId":"communication_sendgrid_webhooks_v3_delete_parse_setting","summary":"Delete a parse setting","description":"DELETE /v3/user/webhooks/parse/settings/{hostname}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["hostname"],"properties":{"hostname":{"type":"string","description":"The hostname associated with the inbound parse setting that you would like to retrieve."},"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-webhooks-v3/list-parse-static":{"get":{"operationId":"communication_sendgrid_webhooks_v3_list_parse_static","summary":"Retrieves Inbound Parse Webhook statistics.","description":"GET /v3/user/webhooks/parse/stats","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"The number of statistics to return on each page.","schema":{"type":"string","description":"The number of statistics to return on each page."}},{"name":"offset","in":"query","required":false,"description":"The number of statistics to skip.","schema":{"type":"string","description":"The number of statistics to skip."}},{"name":"aggregated_by","in":"query","required":false,"description":"How you would like the statistics to by grouped.","schema":{"type":"string","enum":["day","week","month"],"description":"How you would like the statistics to by grouped."}},{"name":"start_date","in":"query","required":true,"description":"The starting date of the statistics you want to retrieve. Must be in the format YYYY-MM-DD","schema":{"type":"string","description":"The starting date of the statistics you want to retrieve. Must be in the format YYYY-MM-DD"}},{"name":"end_date","in":"query","required":false,"description":"The end date of the statistics you want to retrieve. Must be in the format YYYY-MM-DD","schema":{"type":"string","default":"The day the request is made.","description":"The end date of the statistics you want to retrieve. Must be in the format YYYY-MM-DD"}},{"name":"on-behalf-of","in":"query","required":false,"description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…","schema":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-webhooks-v3/list-all-security-policies":{"get":{"operationId":"communication_sendgrid_webhooks_v3_list_all_security_policies","summary":"Retrieve all webhook security policies for your account","description":"GET /v3/user/webhooks/security/policies","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…","schema":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-webhooks-v3/create-security-policy":{"post":{"operationId":"communication_sendgrid_webhooks_v3_create_security_policy","summary":"Create a new webhook security policy","description":"POST /v3/user/webhooks/security/policies","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-webhooks-v3/get-security-policy":{"get":{"operationId":"communication_sendgrid_webhooks_v3_get_security_policy","summary":"Retrieve a specific webhook security policy","description":"GET /v3/user/webhooks/security/policies/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}},{"name":"on-behalf-of","in":"query","required":false,"description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…","schema":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-webhooks-v3/update-security-policy":{"post":{"operationId":"communication_sendgrid_webhooks_v3_update_security_policy","summary":"Update an existing webhook security policy","description":"PATCH /v3/user/webhooks/security/policies/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-webhooks-v3/delete-security-policy":{"post":{"operationId":"communication_sendgrid_webhooks_v3_delete_security_policy","summary":"Delete a specific webhook security policy","description":"DELETE /v3/user/webhooks/security/policies/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"force":{"type":"boolean"},"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}