Webhooks API manages domain's webhooks. You can create, access and delete webhooks programmatically.
Get all webhooks
Listing urls of every webhooks under the domain.
A 200 response
Response Schema: application/json
required | object | ||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
A 401 response
A 404 response
- curl
- Go
- Node.js
- PHP
- Java
- Python
- C#
- Ruby
- 200
- 401
- 404
{
}Create a webhook
Create a list of one or more urls provided by the url query params. Targeted webhook name is defined through the id param.
Request Body schema: multipart/form-datarequired
- curl
- Go
- Node.js
- PHP
- Java
- Python
- C#
- Ruby
- 200
- 401
- 404
Get webhooks by type
Get the list of urls for a webhook identified by its name. Can be either accepted, clicked, click, opened, open, unsubscribed, unsubscribe, bounce, deliver, delivered, drop, spam, state_change, permanent_fail, temporary_fail or complained.
- curl
- Go
- Node.js
- PHP
- Java
- Python
- C#
- Ruby
- 200
- 401
- 404
Update a webhook
Replace the list of urls by the given one with the url param. Here is the list of supported webhook: accepted, opened, clicked, unsubscribed, delivered, permanent_fail, temporary_fail and complained.
path Parameters
Request Body schema: multipart/form-datarequired
- curl
- Go
- Node.js
- PHP
- Java
- Python
- C#
- Ruby
- 200
- 401
- 404
