Skip to main content
POST
Create a webhook endpoint

Authorizations

X-API-KEY
string
header
required

Your access token, from your dashboard under API keys.

Body

application/json
url
string<uri>
required

Your HTTPS endpoint. Private and local addresses are refused.

trigger_events
enum<string>[]
required

The events sent to this URL.

Minimum array length: 1
Available options:
email.new,
email.new.bounce,
email.update,
email.delete,
email.draft.new,
email.draft.delete,
email.folder.create,
email.folder.update,
email.folder.delete,
tracking.open,
tracking.click,
account.add,
account.reconnect,
account.remove,
account.status.running,
account.status.errored,
account.status.disconnected,
account.initial_sync.running,
account.initial_sync.completed,
account.initial_sync.failed
account_ids
string[]

Only these accounts (acc_…). Empty = every account.

description
string

Your description. Not sent in events.

headers
object[]

Extra headers sent with every call.

enabled
boolean
default:true

Response

The endpoint.

object
string
Allowed value: "WebhookEndpoint"
id
string

we_…

url
string<uri>
description
string | null
trigger_events
enum<string>[]
Available options:
email.new,
email.new.bounce,
email.update,
email.delete,
email.draft.new,
email.draft.delete,
email.folder.create,
email.folder.update,
email.folder.delete,
tracking.open,
tracking.click,
account.add,
account.reconnect,
account.remove,
account.status.running,
account.status.errored,
account.status.disconnected,
account.initial_sync.running,
account.initial_sync.completed,
account.initial_sync.failed
account_ids
string[]
headers
object[]
secret
string

Signs the calls (HMAC-SHA256).

enabled
boolean
created_at
string<date-time>