{"componentChunkName":"component---src-templates-api-js","path":"/api/webhooks/","result":{"data":{"allApiBlueprint":{"edges":[{"node":{"meta":{"title":"A/B Testing API","label":"New"},"fields":{"path":"/api/ab-testing/","file":"ab-testing.apib"}}},{"node":{"meta":{"title":"Data Privacy API","label":"New"},"fields":{"path":"/api/data-privacy/","file":"data-privacy.apib"}}},{"node":{"meta":{"title":"Events API","label":null},"fields":{"path":"/api/events/","file":"events.apib"}}},{"node":{"meta":{"title":"Ingest API","label":"Private Access"},"fields":{"path":"/api/events-ingest/","file":"events-ingest.apib"}}},{"node":{"meta":{"title":"Inbound Domains API","label":null},"fields":{"path":"/api/inbound-domains/","file":"inbound-domains.apib"}}},{"node":{"meta":{"title":"Account API","label":null},"fields":{"path":"/api/account/","file":"account.apib"}}},{"node":{"meta":{"title":"API Overview","label":null},"fields":{"path":"/api/","file":"index.apib"}}},{"node":{"meta":{"title":"Automatic Inline Seeding","label":"Deliverability"},"fields":{"path":"/api/inline-seeds/","file":"inline-seeds.apib"}}},{"node":{"meta":{"title":"Labs APIs","label":null},"fields":{"path":"/api/labs/","file":"labs.apib"}}},{"node":{"meta":{"title":"Message Events API","label":null},"fields":{"path":"/api/message-events/","file":"message-events.apib"}}},{"node":{"meta":{"title":"Recipient Validation API","label":"New"},"fields":{"path":"/api/recipient-validation/","file":"recipient-validation.apib"}}},{"node":{"meta":{"title":"IP Pools API","label":null},"fields":{"path":"/api/ip-pools/","file":"ip-pools.apib"}}},{"node":{"meta":{"title":"Seed List API","label":"Deliverability"},"fields":{"path":"/api/seed-list/","file":"seed-list.apib"}}},{"node":{"meta":{"title":"Bounce Domains API","label":null},"fields":{"path":"/api/bounce-domains/","file":"bounce-domains.apib"}}},{"node":{"meta":{"title":"Recipient Lists API","label":null},"fields":{"path":"/api/recipient-lists/","file":"recipient-lists.apib"}}},{"node":{"meta":{"title":"Sending IPs API","label":null},"fields":{"path":"/api/sending-ips/","file":"sending-ips.apib"}}},{"node":{"meta":{"title":"Relay Webhooks API","label":null},"fields":{"path":"/api/relay-webhooks/","file":"relay-webhooks.apib"}}},{"node":{"meta":{"title":"SMTP API","label":null},"fields":{"path":"/api/smtp/","file":"smtp.apib"}}},{"node":{"meta":{"title":"Snippets API","label":"New"},"fields":{"path":"/api/snippets/","file":"snippets.apib"}}},{"node":{"meta":{"title":"Subaccounts API","label":null},"fields":{"path":"/api/subaccounts/","file":"subaccounts.apib"}}},{"node":{"meta":{"title":"Sending Domains API","label":null},"fields":{"path":"/api/sending-domains/","file":"sending-domains.apib"}}},{"node":{"meta":{"title":"Suppression List API","label":null},"fields":{"path":"/api/suppression-list/","file":"suppression-list.apib"}}},{"node":{"meta":{"title":"Template Language","label":null},"fields":{"path":"/api/template-language/","file":"template-language.apib"}}},{"node":{"meta":{"title":"Tracking Domains API","label":null},"fields":{"path":"/api/tracking-domains/","file":"tracking-domains.apib"}}},{"node":{"meta":{"title":"Templates API","label":null},"fields":{"path":"/api/templates/","file":"templates.apib"}}},{"node":{"meta":{"title":"Transmissions API","label":null},"fields":{"path":"/api/transmissions/","file":"transmissions.apib"}}},{"node":{"meta":{"title":"Event Webhooks API","label":null},"fields":{"path":"/api/webhooks/","file":"webhooks.apib"}}},{"node":{"meta":{"title":"Usage API","label":null},"fields":{"path":"/api/usage/","file":"usage.apib"}}},{"node":{"meta":{"title":"Metrics API","label":null},"fields":{"path":"/api/metrics/","file":"metrics.apib"}}}]},"apiBlueprint":{"ast":{"element":"parseResult","content":[{"element":"category","meta":{"classes":{"element":"array","content":[{"element":"string","content":"api"}]},"title":{"element":"string","content":""}},"attributes":{"meta":{"element":"array","content":[{"element":"member","meta":{"classes":{"element":"array","content":[{"element":"string","content":"user"}]}},"content":{"key":{"element":"string","content":"FORMAT"},"value":{"element":"string","content":"1A"}}},{"element":"member","meta":{"classes":{"element":"array","content":[{"element":"string","content":"user"}]}},"content":{"key":{"element":"string","content":"title"},"value":{"element":"string","content":"Event Webhooks API"}}},{"element":"member","meta":{"classes":{"element":"array","content":[{"element":"string","content":"user"}]}},"content":{"key":{"element":"string","content":"description"},"value":{"element":"string","content":"Manage event webhooks, which enable you to receive push updates of the raw events generated by SparkPost."}}}]}},"content":[{"element":"category","meta":{"classes":{"element":"array","content":[{"element":"string","content":"resourceGroup"}]},"title":{"element":"string","content":"Webhooks"}},"content":[{"element":"copy","content":"[Webhooks](https://en.wikipedia.org/wiki/Webhook) allow us to push raw events we collect about your emails over to your servers. Batches of events are delivered through a POST request to the defined target URL. You can use this endpoint to create and manage webhooks, or you can create one from the [app](https://app.sparkpost.com/webhooks/create) ([EU](https://app.eu.sparkpost.com/webhooks/create)).  For inbound relay webhooks, see [Relay Webhooks](https://developers.sparkpost.com/api/relay-webhooks/).\n\n### Batch Information\n\n-   Any webhook batch that does not receive an HTTP 200 response will be retried for a total of 8 hours before the data is discarded.\n\n-   Each webhook batch contains the header `X-MessageSystems-Batch-ID`, which is useful for detecting and prevention of processing duplicate batches. Additionally within each event the `event_id` is unique and can also be used in duplicate detection and prevention.\n\n-   Webhooks posting to your endpoint will timeout after 10 seconds. For best results, write webhook batches to disk and then process asynchronously to minimize data loss if you have a problem with your database.\n\n-   Webhook batch status is available for 24 hours via the UI or the API.\n\n-   See [Best Practices for Managing Webhook Data Streams](https://www.sparkpost.com/docs/tech-resources/webhook-data-streams/) for more information on how best to consume webhooks.\n\n-   See [Webhook Authentication and Security](https://www.sparkpost.com/docs/tech-resources/webhook-authentication/) for highly recommended security measures.\n\n-   For further information on our event types see the [Webhook Event Reference Guide](https://www.sparkpost.com/docs/tech-resources/webhook-event-reference/)\n\n### Webhook Event Types\n\nYou can receive any of the following types of events in webhook payloads.\n\n<WebhookEvents></WebhookEvents>\n\n## Webhooks Object\n\n<DataStructure id=\"ec073ef0de02a91ecc0c1f8d4a8bf796\"  title=\"Attributes\"  sample=\"%7B%0A%20%20%20%20%22name%22%3A%20%22Example%20webhook%22%2C%0A%20%20%20%20%22target%22%3A%20%22http%3A//client.example.com/example-webhook%22%2C%0A%20%20%20%20%22events%22%3A%20%5B%22delivery%22%2C%20%22injection%22%2C%20%22open%22%2C%20%22click%22%5D%2C%0A%20%20%20%20%22active%22%3A%20true%2C%0A%20%20%20%20%22exception_subaccounts%22%3A%20%5B123%5D%2C%0A%20%20%20%20%22custom_headers%22%3A%20%7B%0A%20%20%20%20%20%20%20%20%22x-api-key%22%3A%20%22abcd%22%0A%20%20%20%20%7D%2C%0A%20%20%20%20%22auth_type%22%3A%20%22basic%22%2C%0A%20%20%20%20%22auth_credentials%22%3A%20%7B%0A%20%20%20%20%20%20%20%20%22username%22%3A%20%22basicauthuser%22%2C%0A%20%20%20%20%20%20%20%20%22password%22%3A%20%22mypassword%22%0A%20%20%20%20%7D%0A%7D\"></DataStructure>\n\n<br/>\n\n___\n\n**The SparkPost Webhooks API uses MaxMind software [MaxMind License](https://www.maxmind.com/download/geoip/database/LICENSE.txt)**"},{"element":"resource","meta":{"title":{"element":"string","content":"Create a Webhook"}},"attributes":{"href":{"element":"string","content":"/v1/webhooks"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Create a Webhook"}},"attributes":{"href":{"element":"string","content":"/v1/webhooks"}},"content":[{"element":"copy","content":"When a webhook is created, a test POST request is sent to the `target` URL. If this request does not receive an HTTP 200 response, your request to the Webhook API will fail with HTTP 400 and the webhook will not be created. If created successfully, the webhook will begin to receive event data after 1 minute.\n\nWebhooks only support standard ports, port 80 for HTTP traffic and port 443 for HTTPS traffic. You will not be able to create a webhook using a non-standard port.\n\n<DataStructure id=\"e63f94c43a3092920be8ff8b947d1e6d\"  ></DataStructure>"},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"name\": \"Example webhook\",\n      \"target\": \"http://client.example.com/example-webhook\",\n      \"custom_headers\": {\n          \"x-api-key\": \"abcd\"\n      },\n      \"auth_type\": \"oauth2\",\n      \"auth_request_details\": {\n          \"url\": \"http://client.example.com/tokens\",\n          \"body\": {\n              \"client_id\": \"CLIENT123\",\n              \"client_secret\": \"9sdfj791d2bsbf\",\n              \"grant_type\": \"client_credentials\"\n          }\n      },\n      \"exception_subaccounts\": [123],\n      \"events\": [\n          \"delivery\",\n          \"injection\",\n          \"open\",\n          \"click\"\n      ]\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"results\": {\n          \"id\": \"12affc24-f183-11e3-9234-3c15c2c818c2\",\n          \"links\": [\n              {\n                  \"href\": \"/api/v1/webhooks/12affc24-f183-11e3-9234-3c15c2c818c2\",\n                  \"rel\": \"urn.msys.webhooks.webhook\",\n                  \"method\": [ \"GET\", \"PUT\" ]\n              }\n          ]\n      }\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"name\": \"Example webhook\",\n      \"target\": \"http://client.example.com/example-webhook\",\n      \"custom_headers\": {\n          \"x-api-key\": \"abcd\"\n      },\n      \"auth_type\": \"oauth2\",\n      \"auth_request_details\": {\n          \"url\": \"http://client.example.com/tokens\",\n          \"body\": {\n              \"client_id\": \"CLIENT123\",\n              \"client_secret\": \"9sdfj791d2bsbf\",\n              \"grant_type\": \"client_credentials\"\n          }\n      },\n      \"exception_subaccounts\": [123],\n      \"events\": [\n          \"delivery\",\n          \"injection\",\n          \"open\",\n          \"click\"\n      ]\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"400"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"code\": 400,\n              \"message\": \"POST to webhook tokens URL failed\",\n              \"response\": {\n                  \"body\": \"response body\",\n                  \"headers\": {\n                      \"connection\": \"close\",\n                      \"content-length\": \"536\",\n                      \"content-type\": \"text/html; charset=iso-8859-1\"\n                  },\n                  \"status\": 502\n              }\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Validate a Webhook"}},"attributes":{"href":{"element":"string","content":"/v1/webhooks/{id}/validate"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Validate a Webhook"}},"attributes":{"href":{"element":"string","content":"/v1/webhooks/{id}/validate"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"title":{"element":"string","content":"uuid"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"id"},"value":{"element":"string","content":"12affc24-f183-11e3-9234-3c15c2c818c2"}}}]}},"content":[{"element":"copy","content":"The validation request sends an example message event batch the target URL, validates that the target responds with HTTP 200,\nand returns information on the response received from the target.\n\n#### Sample Batch\n\n```\n[\n  {\n    \"msys\": {}\n  }\n]\n```"},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  [\n      {\n          \"msys\": {}\n      }\n  ]\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"results\": {\n          \"msg\": \"Test POST to endpoint succeeded\",\n          \"response\": {\n              \"status\": 200,\n              \"headers\": {\n                  \"Content-Type\": \"text/plain\"\n              },\n              \"body\": \"OK\"\n          }\n      }\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Retrieve a Webhook"}},"attributes":{"href":{"element":"string","content":"/v1/webhooks/{id}{?timezone}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Retrieve a Webhook"}},"attributes":{"href":{"element":"string","content":"/v1/webhooks/{id}{?timezone}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"title":{"element":"string","content":"uuid"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"id"},"value":{"element":"string","content":"12affc24-f183-11e3-9234-3c15c2c818c2"}}},{"element":"member","meta":{"description":{"element":"string","content":"Standard timezone identification string."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"timezone"},"value":{"element":"string","attributes":{"default":{"element":"string","content":"UTC"}},"content":"America/New_York"}}}]}},"content":[{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}},{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"results\": {\n          \"name\": \"Example webhook\",\n          \"target\": \"http://client.example.com/example-webhook\",\n          \"events\": [\n              \"delivery\",\n              \"injection\",\n              \"open\",\n              \"click\"\n          ],\n          \"exception_subaccounts\": [\"123\"],\n          \"auth_type\": \"oauth2\",\n          \"auth_request_details\": {\n              \"url\": \"https://oauth.myurl.com/tokens\",\n              \"body\": {\n                  \"client_id\": \"<oauth client id>\",\n                  \"client_secret\": \"<oauth client secret>\"\n              }\n          },\n          \"auth_credentials\": {\n              \"access_token\": \"<oauth token>\",\n              \"expires_in\": 3600\n          },\n          \"auth_token\": \"\",\n          \"custom_headers\": {\n              \"x-api-key\": \"abcd\"\n          },\n          \"active\": true,\n          \"links\": [\n              {\n                  \"href\": \"/api/v1/webhooks/12affc24-f183-11e3-9234-3c15c2c818c2/validate\",\n                  \"rel\": \"urn.msys.webhooks.validate\",\n                  \"method\": [\"POST\"]\n              },\n              {\n                  \"href\": \"/api/v1/webhooks/12affc24-f183-11e3-9234-3c15c2c818c2/batch-status\",\n                  \"rel\": \"urn.msys.webhooks.batches\",\n                  \"method\": [\"GET\"]\n              }\n          ]\n      }\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Retrieve Batch Status Information"}},"attributes":{"href":{"element":"string","content":"/v1/webhooks/{id}/batch-status{?limit}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Retrieve Batch Status Information"}},"attributes":{"href":{"element":"string","content":"/v1/webhooks/{id}/batch-status{?limit}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"title":{"element":"string","content":"uuid"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"id"},"value":{"element":"string","content":"12affc24-f183-11e3-9234-3c15c2c818c2"}}},{"element":"member","meta":{"description":{"element":"string","content":"Maximum number of results to return."},"title":{"element":"string","content":"int"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"limit"},"value":{"element":"string","attributes":{"default":{"element":"string","content":"1000"}},"content":"1000"}}}]}},"content":[{"element":"copy","content":"<DataStructure id=\"0272071d35a82fa58abae232c5fec79a\"  title=\"Batch Status Object\" ></DataStructure>\n\nWhen SparkPost does not get a 200 response from your webhook consumer endpoint then the batch is failed and SparkPost will retry the batch multiple times for a period of 8 hours. Status information is provided on any failed batches and those that successed on retry.  Batch status is available in the UI and API for 24 hours."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}},{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"    {\n        \"results\": [\n            {\n                \"batch_id\": \"032d330540298f54f0e8bcc1373f3cfd\",\n                \"ts\": \"2014-07-30T21:38:08.000Z\",\n                \"attempts\": 7,\n                \"response_code\": \"200\",\n                \"latency\": 160\n            },\n            {\n                \"batch_id\": \"13c6764994a8f6b4e29906d5712ca7d\",\n                \"ts\": \"2014-07-30T20:38:08.000Z\",\n                \"attempts\": 2,\n                \"failure_code\": \"400\",\n                \"response_code\": \"400\",\n                \"latency\": 210\n            }\n        ]\n    }\n\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Update a Webhook"}},"attributes":{"href":{"element":"string","content":"/v1/webhooks/{id}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Update a Webhook"}},"attributes":{"href":{"element":"string","content":"/v1/webhooks/{id}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"title":{"element":"string","content":"uuid"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"id"},"value":{"element":"string","content":"12affc24-f183-11e3-9234-3c15c2c818c2"}}}]}},"content":[{"element":"copy","content":"<DataStructure id=\"1d7bd32e8eb0a6ecd2155eb49caad909\"  ></DataStructure>\n\nIf you change to the `target` URL, a test POST request will be sent. If this request does not receive an HTTP 200 response, your request to the Webhooks API will fail with HTTP 400, and the webhook will not be updated.\n\nAny batches already queued for delivery to this webhook will not be affected. For example, if you change the webhook's target URL, batches already queued for delivery will still be POSTed to the previous URL."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"PUT"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"name\": \"Renamed webhook\",\n      \"events\": [\n          \"generation_rejection\",\n          \"delay\"\n      ],\n      \"subaccount_id\": 123,\n      \"auth_type\": \"none\",\n      \"custom_headers\": {\n          \"x-api-key\": \"abcd\"\n      }\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"results\": {\n          \"id\": \"12affc24-f183-11e3-9234-3c15c2c818c2\",\n          \"links\": [\n              {\n                  \"href\": \"/api/v1/webhooks/12affc24-f183-11e3-9234-3c15c2c818c2/validate\",\n                  \"rel\": \"urn.msys.webhooks.validate\",\n                  \"method\": [\"POST\"]\n              }\n          ]\n      }\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Delete a Webhook"}},"attributes":{"href":{"element":"string","content":"/v1/webhooks/{id}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Delete a Webhook"}},"attributes":{"href":{"element":"string","content":"/v1/webhooks/{id}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"title":{"element":"string","content":"uuid"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"id"},"value":{"element":"string","content":"12affc24-f183-11e3-9234-3c15c2c818c2"}}}]}},"content":[{"element":"copy","content":"This will not affect any webhook batches that are already queued for delivery."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"DELETE"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"204"}}}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"List all Webhooks"}},"attributes":{"href":{"element":"string","content":"/v1/webhooks{?timezone}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"List all Webhooks"}},"attributes":{"href":{"element":"string","content":"/v1/webhooks{?timezone}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"description":{"element":"string","content":"Standard timezone identification string."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"timezone"},"value":{"element":"string","attributes":{"default":{"element":"string","content":"UTC"}},"content":"America/New_York"}}}]}},"content":[{"element":"copy","content":"Returns a list of all your webhooks."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}},{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"results\": [\n          {\n              \"id\": \"a2b83490-10df-11e4-b670-c1ffa86371ff\",\n              \"name\": \"Some webhook\",\n              \"target\": \"http://client.example.com/some-webhook\",\n              \"events\": [\n                  \"delivery\",\n                  \"injection\",\n                  \"open\",\n                  \"click\"\n              ],\n              \"auth_type\": \"basic\",\n              \"auth_request_details\": {\n\n              },\n              \"auth_credentials\": {\n                  \"username\": \"basicuser\",\n                  \"password\": \"somepass\"\n              },\n              \"auth_token\": \"\",\n              \"last_successful\": \"2014-08-01 16:09:15\",\n              \"last_failure\": \"2014-06-01 15:15:45\",\n              \"custom_headers\": {\n                  \"x-api-key\": \"abcd\"\n              },\n              \"active\": true,\n              \"links\": [\n                  {\n                      \"href\": \"/api/v1/webhooks/a2b83490-10df-11e4-b670-c1ffa86371ff\",\n                      \"rel\": \"urn.msys.webhooks.webhook\",\n                      \"method\": [\n                          \"GET\",\n                          \"PUT\"\n                      ]\n                  }\n              ]\n          },\n          {\n              \"id\": \"12affc24-f183-11e3-9234-3c15c2c818c2\",\n              \"name\": \"Example webhook\",\n              \"target\": \"http://client.example.com/example-webhook\",\n              \"events\": [\n                  \"delivery\",\n                  \"injection\",\n                  \"open\",\n                  \"click\"\n              ],\n              \"auth_type\": \"oauth2\",\n              \"auth_request_details\": {\n                  \"url\": \"https://oauth.myurl.com/tokens\",\n                  \"body\": {\n                      \"client_id\": \"<oauth client id>\",\n                      \"client_secret\": \"<oauth client secret>\"\n                  }\n              },\n              \"auth_credentials\": {\n                  \"access_token\": \"<oauth token>\",\n                  \"expires_in\": 3600\n              },\n              \"auth_token\": \"\",\n              \"last_successful\": \"2014-07-01 16:09:15\",\n              \"last_failure\": \"2014-08-01 15:15:45\",\n              \"active\": true,\n              \"links\": [\n                  {\n                      \"href\": \"/api/v1/webhooks/12affc24-f183-11e3-9234-3c15c2c818c2\",\n                      \"rel\": \"urn.msys.webhooks.webhook\",\n                      \"method\": [\n                          \"GET\",\n                          \"PUT\"\n                      ]\n                  }\n              ]\n          },\n          {\n              \"id\": \"123456-abcd-efgh-7890-123445566778\",\n              \"name\": \"Another webhook\",\n              \"target\": \"http://client.example.com/another-example\",\n              \"events\": [\n                  \"generation_rejection\",\n                  \"generation_failure\"\n              ],\n              \"auth_type\": \"none\",\n              \"auth_request_details\": {\n\n              },\n              \"auth_credentials\": {\n\n              },\n              \"auth_token\": \"5ebe2294ecd0e0f08eab7690d2a6ee69\",\n              \"active\": true,\n              \"links\": [\n                  {\n                      \"href\": \"/api/v1/webhooks/123456-abcd-efgh-7890-123445566778\",\n                      \"rel\": \"urn.msys.webhooks.webhook\",\n                      \"method\": [\n                          \"GET\",\n                          \"PUT\"\n                      ]\n                  }\n              ]\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Documentation"}},"attributes":{"href":{"element":"string","content":"/v1/webhooks/events/documentation"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Events Documentation"}},"content":[{"element":"copy","content":"Returns a list of descriptions of the events, event types, and event fields that could be included in a webhooks batches to your target URL."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n    \"results\": {\n      \"message_event\": { ... },\n      \"track_event\": { ... },\n      ...\n    }\n  }\n"}]}]}]},{"element":"transition","meta":{"title":{"element":"string","content":"Event Samples"}},"attributes":{"href":{"element":"string","content":"/v1/webhooks/events/samples{?events}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"description":{"element":"string","content":"Event types for which to get a sample payload, use the [Events Documentation](#webhooks-documentation) endpoint to list the available event types, defaults to all event types."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"events"},"value":{"element":"string","content":"bounce"}}}]}},"content":[{"element":"copy","content":"Returns an example of the event data that will be posted by a webhook for the specified events.\n\nThe data that will arrive at your target URL during normal operation (as opposed to calls to this endpoint) will <strong>not</strong> contain the top level <code>results</code> key shown in the example response."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n    \"results\": [\n      {\n        \"msys\": {\n          \"message_event\": { ... }\n        }\n      }\n    ]\n  }\n"}]}]}]}]}]},{"element":"category","meta":{"classes":{"element":"array","content":[{"element":"string","content":"dataStructures"}]}},"content":[{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"ec073ef0de02a91ecc0c1f8d4a8bf796"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Name for webhook"}},"content":{"key":{"element":"string","content":"name"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"URL of the target to which to POST event batches."}},"content":{"key":{"element":"string","content":"target"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Array of event types this webhook will send. Use the [Events Documentation](#webhooks-documentation) endpoint to list the available event types."}},"content":{"key":{"element":"string","content":"events"},"value":{"element":"array"}}},{"element":"member","meta":{"description":{"element":"string","content":"The status of the webhook. When false, the target will no longer receive batches."}},"content":{"key":{"element":"string","content":"active"},"value":{"element":"boolean"}}},{"element":"member","meta":{"description":{"element":"string","content":"Object of custom headers to be used during POST requests to target."}},"content":{"key":{"element":"string","content":"custom_headers"},"value":{"element":"object"}}},{"element":"member","meta":{"description":{"element":"string","content":"Array of subaccount numbers to prevent receiving events in your webhook (only available for webhooks with Primary and All Subaccounts event source)."}},"content":{"key":{"element":"string","content":"exception_subaccounts"},"value":{"element":"array"}}},{"element":"member","meta":{"description":{"element":"string","content":"Type of authentication to be used during POST requests to target. Read more about [webhook authentication](https://www.sparkpost.com/docs/tech-resources/webhook-authentication/#webhook-authentication-set-up)."}},"content":{"key":{"element":"string","content":"auth_type"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"string","content":"none"},{"element":"string","content":"basic"},{"element":"string","content":"oauth2"}]}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Object containing details needed to request authorization token for OAuth 2.0. This is required when `auth_type` is oauth2."}},"content":{"key":{"element":"string","content":"auth_request_details"},"value":{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"The URL for the authorization server."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"url"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"The body to send in the request to the authorization server. This likely should contain the client ID, client secret, and grant type."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"body"},"value":{"element":"object"}}}]}}},{"element":"member","meta":{"description":{"element":"string","content":"Object containing credentials needed to make authorized POST requests for Basic Authentication. This is required when `auth_type` is basic. When `auth_type` is oauth2, it is generated from `auth_request_details`."}},"content":{"key":{"element":"string","content":"auth_credentials"},"value":{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"The username for Basic Authentication."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"username"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"The password for Basic Authentication."}},"content":{"key":{"element":"string","content":"password"},"value":{"element":"string"}}}]}}},{"element":"member","meta":{"description":{"element":"string","content":"  <span class=\"label label-danger\"><strong>Deprecated</strong></span> in favor of the `auth_type` field. <br /> Authentication token to present in the `X-MessageSystems-Webhook-Token` header of POST requests to target."}},"content":{"key":{"element":"string","content":"auth_token"},"value":{"element":"string"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"e63f94c43a3092920be8ff8b947d1e6d"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Name for webhook"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"name"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"URL of the target to which to POST event batches. Only ports 80 for http and 443 for https can be set."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"target"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Array of event types this webhook will send. Use the [Events Documentation](#webhooks-documentation) endpoint to list the available event types."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"events"},"value":{"element":"array"}}},{"element":"member","meta":{"description":{"element":"string","content":"The status of the webhook. When false, the target will no longer receive batches."}},"content":{"key":{"element":"string","content":"active"},"value":{"element":"boolean","attributes":{"default":{"element":"boolean","content":true}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Object of custom headers to be used during POST requests to target."}},"content":{"key":{"element":"string","content":"custom_headers"},"value":{"element":"object"}}},{"element":"member","meta":{"description":{"element":"string","content":"Array of subaccount numbers to prevent receiving events in your webhook (only available for webhooks with Primary and All Subaccounts event source). Must not have duplicate values nor be empty. Integer values only. Max size: 10."}},"content":{"key":{"element":"string","content":"exception_subaccounts"},"value":{"element":"array"}}},{"element":"member","meta":{"description":{"element":"string","content":"  Type of authentication to be used during POST requests to target. Read more about [webhook authentication](https://www.sparkpost.com/docs/tech-resources/webhook-authentication/#webhook-authentication-set-up)."}},"content":{"key":{"element":"string","content":"auth_type"},"value":{"element":"enum","attributes":{"default":{"element":"enum","content":{"element":"string","content":"none"}},"enumerations":{"element":"array","content":[{"element":"string","content":"none"},{"element":"string","content":"basic"},{"element":"string","content":"oauth2"}]}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Object containing details needed to request authorization token for OAuth 2.0. This is required when `auth_type` is oauth2."}},"content":{"key":{"element":"string","content":"auth_request_details"},"value":{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"The URL for the authorization server."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"url"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"The body to send in the request to the authorization server. This likely should contain the client ID, client secret, and grant type."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"body"},"value":{"element":"object"}}}]}}},{"element":"member","meta":{"description":{"element":"string","content":"Object containing credentials needed to make authorized POST requests for Basic Authentication. This is required when `auth_type` is basic. When `auth_type` is oauth2, it is generated from `auth_request_details`."}},"content":{"key":{"element":"string","content":"auth_credentials"},"value":{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"The username for Basic Authentication."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"username"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"The password for Basic Authentication."}},"content":{"key":{"element":"string","content":"password"},"value":{"element":"string"}}}]}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"0272071d35a82fa58abae232c5fec79a"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Server response code of the webhook if successful."}},"content":{"key":{"element":"string","content":"response_code"},"value":{"element":"number"}}},{"element":"member","meta":{"description":{"element":"string","content":"Unique identifier of of the requested batch status."}},"content":{"key":{"element":"string","content":"batch_id"},"value":{"element":"number"}}},{"element":"member","meta":{"description":{"element":"string","content":"Number of events inside of the batch."}},"content":{"key":{"element":"string","content":"batch_size"},"value":{"element":"number"}}},{"element":"member","meta":{"description":{"element":"string","content":"Date the the batch was created was created. <br />Format: YYYY-MM-DDTHH:MM:SS+-HH:MM"}},"content":{"key":{"element":"string","content":"ts"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Failure response code if the webhook failed during delivery."}},"content":{"key":{"element":"string","content":"failure_code"},"value":{"element":"number"}}},{"element":"member","meta":{"description":{"element":"string","content":"Unique identifier of the webhook associated with the batch."}},"content":{"key":{"element":"string","content":"webhook_id"},"value":{"element":"number"}}},{"element":"member","meta":{"description":{"element":"string","content":"Number of failed attempts before the batch was delivered. Zero if succeeded on first attempt."}},"content":{"key":{"element":"string","content":"attempts"},"value":{"element":"number"}}},{"element":"member","meta":{"description":{"element":"string","content":"Duration in ms for the entire batch posting HTTP round-trip."}},"content":{"key":{"element":"string","content":"latency"},"value":{"element":"number"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"1d7bd32e8eb0a6ecd2155eb49caad909"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Name for webhook."}},"content":{"key":{"element":"string","content":"name"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"URL of the target to which to POST event batches. Only ports 80 for http and 443 for https can be set."}},"content":{"key":{"element":"string","content":"target"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Array of event types this webhook will send. Use the [Events Documentation](#webhooks-documentation) endpoint to list the available event types."}},"content":{"key":{"element":"string","content":"events"},"value":{"element":"array"}}},{"element":"member","meta":{"description":{"element":"string","content":"The status of the webhook. When false, the target will no longer receive batches."}},"content":{"key":{"element":"string","content":"active"},"value":{"element":"boolean"}}},{"element":"member","meta":{"description":{"element":"string","content":"Object of custom headers to be used during POST requests to target."}},"content":{"key":{"element":"string","content":"custom_headers"},"value":{"element":"object"}}},{"element":"member","meta":{"description":{"element":"string","content":"Array of subaccount numbers to prevent receiving events in your webhook (only available for webhooks with Primary and All Subaccounts event source). Must not have duplicate values. Integers or empty array. New array values will completely replace the current values. Max size: 10."}},"content":{"key":{"element":"string","content":"exception_subaccounts"},"value":{"element":"array"}}},{"element":"member","meta":{"description":{"element":"string","content":"The new Subaccount to be set as the Event Source. Can be any integer number (use -1 for Primary and All Subaccounts or 0 for Primary Account only)."}},"content":{"key":{"element":"string","content":"subaccount_id"},"value":{"element":"number"}}},{"element":"member","meta":{"description":{"element":"string","content":"  Type of authentication to be used during POST requests to target. Read more about [webhook authentication](https://www.sparkpost.com/docs/tech-resources/webhook-authentication/#webhook-authentication-set-up)."}},"content":{"key":{"element":"string","content":"auth_type"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"string","content":"none"},{"element":"string","content":"basic"},{"element":"string","content":"oauth2"}]}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Object containing details needed to request authorization token for OAuth 2.0. This is required when `auth_type` is oauth2."}},"content":{"key":{"element":"string","content":"auth_request_details"},"value":{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"The URL for the authorization server."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"url"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"The body to send in the request to the authorization server. This likely should contain the client ID, client secret, and grant type."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"body"},"value":{"element":"object"}}}]}}},{"element":"member","meta":{"description":{"element":"string","content":"Object containing credentials needed to make authorized POST requests for Basic Authentication. This is required when `auth_type` is basic. When `auth_type` is oauth2, it is generated from `auth_request_details`."}},"content":{"key":{"element":"string","content":"auth_credentials"},"value":{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"The username for Basic Authentication."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"username"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"The password for Basic Authentication."}},"content":{"key":{"element":"string","content":"password"},"value":{"element":"string"}}}]}}}]}}]}]},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":10},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":6176},{"element":"number","content":4}]},{"element":"array","content":[{"element":"number","content":6188},{"element":"number","content":8}]},{"element":"array","content":[{"element":"number","content":6204},{"element":"number","content":21}]},{"element":"array","content":[{"element":"number","content":6233},{"element":"number","content":8}]},{"element":"array","content":[{"element":"number","content":6249},{"element":"number","content":4}]}]}]}},"content":"message-body asset is expected to be a pre-formatted code block, every of its line indented by exactly 12 spaces or 3 tabs"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":10},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":9458},{"element":"number","content":579}]}]}]}},"content":"dangling message-body asset, expected a pre-formatted code block, indent every of it's line by 4 spaces or 1 tabs"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":2},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":11627},{"element":"number","content":49}]}]}]}},"content":"the resource '/v1/webhooks/{id}' is already defined"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":6},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":17020},{"element":"number","content":12}]}]}]}},"content":"missing response HTTP status code, assuming 'Response 200'"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":10},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":17036},{"element":"number","content":4}]},{"element":"array","content":[{"element":"number","content":17044},{"element":"number","content":17}]},{"element":"array","content":[{"element":"number","content":17065},{"element":"number","content":32}]},{"element":"array","content":[{"element":"number","content":17101},{"element":"number","content":30}]},{"element":"array","content":[{"element":"number","content":17135},{"element":"number","content":10}]},{"element":"array","content":[{"element":"number","content":17149},{"element":"number","content":6}]},{"element":"array","content":[{"element":"number","content":17159},{"element":"number","content":4}]}]}]}},"content":"message-body asset is expected to be a pre-formatted code block, every of its line indented by exactly 8 spaces or 2 tabs"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":6},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":17870},{"element":"number","content":12}]}]}]}},"content":"missing response HTTP status code, assuming 'Response 200'"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":10},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":17886},{"element":"number","content":4}]},{"element":"array","content":[{"element":"number","content":17894},{"element":"number","content":17}]},{"element":"array","content":[{"element":"number","content":17915},{"element":"number","content":8}]},{"element":"array","content":[{"element":"number","content":17927},{"element":"number","content":18}]},{"element":"array","content":[{"element":"number","content":17949},{"element":"number","content":35}]},{"element":"array","content":[{"element":"number","content":17988},{"element":"number","content":10}]},{"element":"array","content":[{"element":"number","content":18002},{"element":"number","content":8}]},{"element":"array","content":[{"element":"number","content":18014},{"element":"number","content":6}]},{"element":"array","content":[{"element":"number","content":18024},{"element":"number","content":4}]}]}]}},"content":"message-body asset is expected to be a pre-formatted code block, every of its line indented by exactly 8 spaces or 2 tabs"}]},"TableOfContents":[{"anchor":"#webhooks","title":"Webhooks","children":[{"anchor":"#header-batch-information","title":"Batch Information"},{"anchor":"#header-webhook-event-types","title":"Webhook Event Types"},{"anchor":"#header-webhooks-object","title":"Webhooks Object"},{"anchor":"#webhooks-create-a-webhook","title":"Create a Webhook","children":[{"anchor":"#webhooks-post-create-a-webhook","title":"Create a Webhook"}]},{"anchor":"#webhooks-validate-a-webhook","title":"Validate a Webhook","children":[{"anchor":"#webhooks-post-validate-a-webhook","title":"Validate a Webhook","children":[{"anchor":"#header-sample-batch","title":"Sample Batch"}]}]},{"anchor":"#webhooks-retrieve-a-webhook","title":"Retrieve a Webhook","children":[{"anchor":"#webhooks-get-retrieve-a-webhook","title":"Retrieve a Webhook"}]},{"anchor":"#webhooks-retrieve-batch-status-information","title":"Retrieve Batch Status Information","children":[{"anchor":"#webhooks-get-retrieve-batch-status-information","title":"Retrieve Batch Status Information"}]},{"anchor":"#webhooks-update-a-webhook","title":"Update a Webhook","children":[{"anchor":"#webhooks-put-update-a-webhook","title":"Update a Webhook"}]},{"anchor":"#webhooks-delete-a-webhook","title":"Delete a Webhook","children":[{"anchor":"#webhooks-delete-delete-a-webhook","title":"Delete a Webhook"}]},{"anchor":"#webhooks-list-all-webhooks","title":"List all Webhooks","children":[{"anchor":"#webhooks-get-list-all-webhooks","title":"List all Webhooks"}]},{"anchor":"#webhooks-documentation","title":"Documentation","children":[{"anchor":"#webhooks-get-events-documentation","title":"Events Documentation"},{"anchor":"#webhooks-get-event-samples","title":"Event Samples"}]}]}],"meta":{"title":"Event Webhooks API","description":"Manage event webhooks, which enable you to receive push updates of the raw events generated by SparkPost.","full":false},"fields":{"path":"/api/webhooks/"}}},"pageContext":{"file":"webhooks.apib"}},"staticQueryHashes":["1319884646","1428769721","3859448388"]}