Last updated
Last updated
Receive Web Hook notifications, register your webhook endpoint. Please provide a publicly accessible HTTPS URL to your webhook endpoint.
POST
/webhooks/receipt
Used to register for notifications.
POST
/webhooks/incoming
Use to register for notifications.
POST
/webhooks/click
Headers
Body
Response
We use conventional HTTP response codes to indicate the success or failure of an API request. In general:
2xx indicate success 4xx indicate an error that failed given the information provided (e.g., a required parameter was omitted) 5xx errors indicate an error with ours servers (these are rare).
Use to register for notifications.
To see a full list of our Response codes, please .
Content-Type
application/json
Authorization
Bearer [API Key]
url
string
Yes
URL to receive Delivery Receipt notifications.
This page will document how to Register webhooks for our API to use.