Skip to main content
POST
Create a Webhook Endpoint

Authorizations

Authorization
string
header
required

Bearer Token necessary to use API

Body

application/json

Create Webhook Endpoint Request

name
string
required

The name of the webhook endpoint

api_version
enum<string>
required

The API version for the webhook endpoint

Available options:
2025-09,
preview
url
string<uri>
required

The URL to which the webhook payloads will be delivered

Pattern: ^https://
event_types
enum<string>[]
required

A list of event types that the webhook endpoint will listen to

Minimum array length: 1
Available options:
contact.churned,
contact.converted,
contact.created,
contact.updated,
contract.created,
contract.signed,
coupon.created,
coupon.updated,
credit_note.created,
credit_note.updated,
deal.created,
deal.lost,
deal.reopened,
deal.stage_changed,
deal.updated,
deal.won,
identity_verification.cancelled,
identity_verification.failed,
identity_verification.processing,
identity_verification.succeeded,
invoice.created,
invoice.finalized,
invoice.marked_uncollectible,
invoice.overdue,
invoice.paid,
invoice.payment_failed,
invoice.updated,
note.created,
note.updated,
order.abandoned,
order.completed,
order.created,
order.finalized,
protection_level.created,
protection_level.updated,
subscription.cancelled,
subscription.created,
subscription.ended,
subscription.resumed,
subscription.started,
task.completed,
task.created,
task.reopened,
task.updated,
tenancy.auto_reservation.failed,
tenancy.auto_reservation.partially_succeeded,
tenancy.auto_reservation.succeeded,
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
description
string | null

Optional description for the webhook endpoint

metadata
object | null

Set of key-value pairs for storing additional information on the webhook endpoint. Learn more about metadata.

Response

201 - application/json

webhook endpoint created

Single Webhook Endpoint

endpoint
object

Webhook Endpoint

meta
object