The unique identifier of the organization the webhook belongs to.
environment
string
The environment associated with the webhook.
name
string
The webhook name.
description
string
An optional description for the webhook.
secret
string
The auto-generated webhook secret, used to verify the payload (see the introduction for more details).
verification_token
string
An optional token to set on the webhook, used as an additional verification step for the payload (see the introduction for more details).
url
string
The URL that the webhook will POST payloads to.
subscriptions
array
An array of events that this webhook should subscribe to. If you want to subscribe to an event not listed here, please submit an idea on our product roadmap portal describing your use case.
priority
integer
The priority of the webhook. Attempts for a webhook with lower value will be prioritized over a higher value.
enabled
boolean
Whether the webhook is enabled or not. If false, all queue events are marked as failed without being attempted.
created_at
string
The timestamp when the webhook was created.
updated_at
string
The timestamp when the webhook was last updated.
Example
{
"webhook_id": "274b2899-7957-464b-a609-49939039cd49",
"organization_id": "3f4b2899-7957-464b-a609-49939039cd49",
"name": "Example webhook",
"description": "A webhook for receiving various events",
"secret": "B3a8y1WotX7glI7OxZhX5EAd_6UJ7YEvTJBNQzano4dHjntn9_5AlyPg-dzpX76A",
"enabled": true,
"verification_token": "459106913AF9",
"url": "http://your.url.here",
"subscriptions": [
"policyholder_created"
]
}
