Skip to main content
POST
Add a new webhook

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Below is the JSON payload required for creating a new webhook. Be sure to replace the example URL with your webhook URL and choose a valid webhook event from the following options: bounce,click, open, unsubscribe, complaint, delivery.

Event
string
Example:

"delivery"

WebhookURL
string
Example:

"www.example.com"

Response

200 - application/json

OK

A successfully created webhook returns the NewWebhookID

A successfully created webhook returns the NewWebhookID

NewWebhookID
integer
Example:

972