Create a webhook
Registers a new webhook to receive event notifications.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Request body for creating a new webhook.
The HTTPS URL to deliver webhook events to.
List of event types that will trigger this webhook.
Email lifecycle event type that can trigger a webhook delivery.
accepted, processed, bounced, delivered, opened, clicked, complained, unsubscribed, resubscribed Optional channel scope. If set, only events for this channel trigger the webhook.
Custom headers to include in each webhook request. Each header name is prefixed with X-Customer-.
Whether the webhook is active or not. Defaults to true.
Response
OK
Webhook configuration properties.
Unique identifier for the webhook.
Channel this webhook is scoped to, or null for account-wide.
The HTTPS URL events are delivered to.
HMAC-SHA256 signing key used to verify webhook authenticity. Sent as the X-Helo-Webhook-Signature request header on each delivery.
Whether the webhook is active and will receive events.
Custom headers sent with each webhook delivery.
Event types that trigger this webhook.
Email lifecycle event type that can trigger a webhook delivery.
accepted, processed, bounced, delivered, opened, clicked, complained, unsubscribed, resubscribed The most recent delivery outcome for this webhook, or null if no delivery has been attempted yet.