Skip to main content
POST
Create a webhook for an email domain

Authorizations

Authorization
string
header
required

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

Path Parameters

domain_id
string<uuid>
required

Email domain UUID

Body

application/json
url
string<uri>
required

HTTPS endpoint to deliver subscribed events to.

events
enum<string>[]
required

At least one event type is required.

Minimum array length: 1

Event types a webhook may subscribe to. The union of email.* events (published by email-api) and email_domain.* lifecycle events (published by this service). An event not listed here can never be subscribed to and is silently dropped.

Available options:
email.scheduled,
email.sandbox,
email.queued,
email.sending,
email.sent,
email.delivered,
email.deferred,
email.bounced,
email.failed,
email.complained,
email.opened,
email.clicked,
email.unsubscribed,
email.received,
email_domain.created,
email_domain.verified,
email_domain.degraded,
email_domain.suspended,
email_domain.deleted

Response

Email webhook created

data
object
required
Example: