Update Webhook
Updates an existing webhook. Omitted or null fields are unchanged.
Omitted/null domains preserves associations, while [] clears the
associations of a resulting-scoped webhook. Moving from global to
scoped requires a non-empty domains array in the same request. Moving
to global clears associations and ignores supplied domains.
A domain-scoped key must be authorized for the existing webhook and
every newly supplied domain; changing to global requires
webhooks:write:all.
Note: The webhook secret is not updatable
Authorizations
API key for authentication. Non-empty Security Requirement values are AhaSend API-key roles. Roles listed within one requirement object are jointly required; separate requirement objects are alternatives.
Body
Partial update. Omitted and null scalar fields leave their stored values
unchanged. Domain transition rules depend on the webhook's existing
scope and are described on domains.
Webhook name
255Webhook URL
Whether the webhook is enabled
Trigger on message reception
Trigger on message delivery
Trigger on transient errors
Trigger on permanent failures
Trigger on bounces
Trigger on suppressions
Trigger on opens
Trigger on clicks
Trigger on suppression creation
Trigger on DNS errors
Webhook scope. Omit or send null to keep the current scope.
global, scoped, null Omit or send null to leave domain associations unchanged. An array
replaces associations when the resulting scope is scoped; []
explicitly clears them. Changing a global webhook to scoped
requires a non-empty array in the same request and otherwise
returns HTTP 400. Changing to global clears all associations;
supplied domains are ignored when the resulting scope is global.
Response
Webhook updated successfully
Object type identifier
webhook Unique identifier for the webhook
When the webhook was created
When the webhook was last updated
Webhook name
Webhook URL
Whether the webhook is enabled
Trigger on message reception
Trigger on message delivery
Trigger on transient errors
Trigger on permanent failures
Trigger on bounces
Trigger on suppressions
Trigger on opens
Trigger on clicks
Trigger on suppression creation
Trigger on DNS errors
Webhook scope
global, scoped Domains this webhook applies to. Always present; global webhooks return an empty array.
Number of successful calls
Number of unsuccessful calls
Number of consecutive failed calls
When the webhook was last called

