Skip to main content
POST
/
account
/
webhook
Create a New Webhook
curl --request POST \
  --url https://api.sendpost.io/api/v1/account/webhook \
  --header 'Content-Type: application/json' \
  --header 'X-Account-ApiKey: <api-key>' \
  --data '{
  "enabled": true,
  "url": "https://app.hooli.com/email/webhook",
  "processed": true,
  "delivered": true,
  "dropped": false,
  "softBounced": false,
  "hardBounced": true,
  "opened": true,
  "clicked": true,
  "unsubscribed": true,
  "spam": true
}'
{
  "id": 117,
  "enabled": true,
  "url": "https://app.hooli.com/email/webhook",
  "processed": true,
  "delivered": true,
  "dropped": false,
  "softBounced": false,
  "hardBounced": true,
  "opened": true,
  "clicked": true,
  "unsubscribed": true,
  "spam": true,
  "created": 1567512491588004000
}

Authorizations

​
X-Account-ApiKey
string
header
required

This api key can be used for all account level operations

Body

application/json
​
enabled
boolean

Is the webhook active or in a paused state?

Example:

true

​
url
string

URL endpoint to which webhook calls are sent.

Example:

"https://app.hooli.com/email/webhook"

​
processed
boolean

Trigger webhook on email message being processed.

Example:

true

​
delivered
boolean

Trigger webhook on email message being delivered.

Example:

true

​
dropped
boolean

Trigger webhook on email message being dropped.

Example:

false

​
softBounced
boolean

Trigger webhook on email message being soft bounced.

Example:

false

​
hardBounced
boolean

Trigger webhook on email message being hard bounced.

Example:

true

​
opened
boolean

Trigger webhook on email message being opened.

Example:

true

​
clicked
boolean

Trigger webhook on email message link being clicked.

Example:

true

​
unsubscribed
boolean

Trigger webhook on email message being unsubscribed.

Example:

true

​
spam
boolean

Trigger webhook on email message being marked as spam.

Example:

true

Response

Webhook created successfully.

​
id
integer

Unique ID for the webhook.

Example:

117

​
enabled
boolean

Indicates if the webhook is active or paused.

Example:

true

​
url
string

URL endpoint to which webhook calls need to be made.

Example:

"https://app.hooli.com/email/webhook"

​
processed
boolean

Trigger webhook on email message being processed.

Example:

true

​
delivered
boolean

Trigger webhook on email message being delivered.

Example:

true

​
dropped
boolean

Trigger webhook on email message being dropped.

Example:

false

​
softBounced
boolean

Trigger webhook on email message being soft bounced.

Example:

false

​
hardBounced
boolean

Trigger webhook on email message being hard bounced.

Example:

true

​
opened
boolean

Trigger webhook on email message being opened.

Example:

true

​
clicked
boolean

Trigger webhook on email message link being clicked.

Example:

true

​
unsubscribed
boolean

Trigger webhook on email message being unsubscribed.

Example:

true

​
spam
boolean

Trigger webhook on email message being marked as spam.

Example:

true

​
created
integer

UNIX epoch nano timestamp when the webhook was created.

Example:

1567512491588004000

⌘I