Create Webhook
Creates a new webhook for event notifications. A scoped webhook
requires at least one domain and the key must have write permission for
every supplied domain. A global webhook requires
webhooks:write:all; supplied domains are accepted but ignored, and
the response contains domains: [].
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.
Headers
Optional idempotency key for safe request retries. Must be a unique string for each logical request.
An identical request with a completed stored outcome returns the original status and body. An in-progress
execution returns 409, a changed method/path/body returns 422, and a released 5xx execution may run again.
Keys for non-secret responses expire after 24 hours. API-key create responses include a one-time secret_key,
so successful encrypted replay responses for those operations expire after 5 minutes.
255Path Parameters
Account ID
Body
Webhook name
255Webhook URL
Webhook scope
global, scoped 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
For scoped, a non-empty array is required. For global, this may
be omitted, null, empty, or non-empty; supplied values are accepted
but ignored.
Response
Webhook created 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
Webhook signing secret. Returned only when the webhook is created.

