Webhooks

email_create_webhook_endpoint

Register an HTTPS endpoint to receive email events (delivered, bounced, opened, …) so the customer's system does not have to poll.

write email_create_webhook_endpoint

Register an HTTPS endpoint to receive email events (delivered, bounced, opened, …) so the customer's system does not have to poll. Returns the endpoint WITHOUT its signing secret — the operator copies that from the dashboard.

Parameters

ParameterTypeRequiredDescription
urlstringYesHTTPS endpoint. Must resolve to a public address.
eventTypesstring[]Yese.g. ['email.delivered','email.bounced','webhook.test']. Call email_list_webhook_event_types for the full set.
descriptionstringNo
projectIdstringNoTarget company (project id) — required on project-scoped tools. Call email_list_projects to enumerate companies.

On this page