Skip to main content
POST
Subscribe automation webhook

Authorizations

Authorization
string
header
required

API key authentication. Use your API key as the bearer token.

Body

application/json
target_url
string<uri>
required
Example:

"https://hooks.zapier.com/hooks/catch/123/abc"

event_type
enum<string>
required
Available options:
email.received
Example:

"email.received"

provider
enum<string>
required
Available options:
zapier,
n8n
Example:

"zapier"

inbox_ids
string<uuid>[]

Optional array of inbox UUIDs to scope the trigger.

send_test
boolean

Deprecated and ignored on subscribe. Use the dedicated automation-webhooks test endpoint to send a sample event.

Response

Webhook subscribed

id
string<uuid>
required
organization_id
string<uuid>
required
provider
enum<string>
required
Available options:
zapier,
n8n
Example:

"zapier"

event_type
enum<string>
required
Available options:
email.received
Example:

"email.received"

target_url
string<uri>
required
inbox_ids
string<uuid>[] | null
required
active
boolean
required
created_at
string<date-time>
required