Skip to main content

WebhookCreateRequest

urlstring<uri>required

The URL to receive webhook events.

eventsWebhookEventType[]required

Event types to subscribe to.

Possible values: [email.sent, email.delivered, email.bounced, email.opened, email.clicked, email.complained, email.failed, email.delayed, email.received]

descriptionstring

Optional description of the webhook endpoint.

secretstring

Signing secret. Auto-generated if omitted.

WebhookCreateRequest
{
"url": "string",
"events": [
"email.sent"
],
"description": "string",
"secret": "string"
}