Update a webhook
Modifies an existing webhook by ID.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Unique identifier of the webhook.
Body
Request body for updating a webhook. Only provided fields are changed.
New delivery URL. Must be HTTPS.
Replaces the full list of event type subscriptions.
Email lifecycle event type that can trigger a webhook delivery.
accepted, processed, bounced, delivered, opened, clicked, complained, unsubscribed, resubscribed Set to a UUID to scope to a channel, or null to remove channel scoping.
Replaces all custom headers. Set to null to remove all custom headers.
Enables or disables the webhook.
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.