Properties
| Properties |
|---|
| webhook_id string The unique identifier of the webhook. |
| organization_id string 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. Array can include any of the following: policy_issued, policy_cancelled, policy_cancel_failed, policy_activated, policy_lapsed, policy_not_taken_up, policy_expired, policy_lapse_failed, policy_updated, policy_reactivated, policy_requoted, policy_beneficiaries_updated, policy_covered_people_updated, policyholder_created, policyholder_updated, quote_package_created, application_created, application_updated, claim_opened, claim_sent_to_review, claim_approved, claim_repudiated, claim_paid_out, claim_linked_to_policy, claim_approval_acknowledged, claim_goodwill_acknowledged, claim_no_claim_acknowledged, claim_repudiation_acknowledged, text_note_created, attachment_archived, claim_checklist_item_checked, attachment_created, claim_checklist_item_note_created, claim_approval_not_acknowledged, claim_goodwill_not_acknowledged, claim_no_claim_not_acknowledged, claim_repudiation_not_acknowledged, claim_goodwill, claim_no_claim, claim_reopened, claim_updated, claimant_updated, complaint_opened, notification_created, notification_sent, payment_failed, payment_succeeded, payment_reversed, payment_updates_succeeded, payment_updates_failed, payment_method_assigned. |
| 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"
]
}