Create a new webhook endpoint to receive event notifications.
Required authorization scope: public.webhook_endpoint:write
Bearer Token necessary to use API
Create Webhook Endpoint Request
The name of the webhook endpoint
The API version for the webhook endpoint
2025-09 The URL to which the webhook payloads will be delivered
^https://A list of event types that the webhook endpoint will listen to
1contact.created, contact.updated, contract.created, contract.signed, coupon.created, coupon.updated, credit_note.created, credit_note.updated, deal.created, deal.lost, deal.reopened, deal.updated, deal.won, identity_verification.cancelled, identity_verification.failed, identity_verification.processing, identity_verification.succeeded, invoice.created, invoice.finalized, invoice.marked_uncollectible, invoice.paid, invoice.updated, note.created, note.updated, order.completed, order.created, order.finalized, protection_level.created, protection_level.updated, subscription.cancelled, subscription.created, subscription.ended, subscription.started, task.completed, task.created, task.reopened, task.updated, tenancy.created, tenancy.started, unit.available, unit.created, unit.deallocated, unit.occupied, unit.overlocked, unit.repossessed, unit.reserved, unit.unavailable, unit.updated, unit_type.created, unit_type.updated Optional description for the webhook endpoint
Set of key-value pairs for storing additional information on the webhook endpoint. Learn more about metadata.