Skip to main content
POST
Create a webhook

Authorizations

Authorization
string
header
required

Use the Authorization header with Bearer scheme.

Examples:

  • API Key: Authorization: Bearer calid_xxxxx

Body

application/json
eventTriggers
enum<string>[]
required

Webhook events that should trigger delivery.

Available options:
BOOKING_CREATED,
BOOKING_PAYMENT_INITIATED,
BOOKING_PAID,
BOOKING_RESCHEDULED,
BOOKING_REQUESTED,
BOOKING_CANCELLED,
BOOKING_REJECTED,
BOOKING_NO_SHOW_UPDATED,
FORM_SUBMITTED,
OOO_CREATED
Example:
subscriberUrl
string
required

Destination URL that receives webhook requests.

Example:

"https://example.com/webhooks/calid"

payloadTemplate
string | null

Optional custom payload template delivered to the subscriber.

Example:

"{\"event\":\"BOOKING_CREATED\",\"bookingId\":\"bk_123\"}"

active
boolean

Whether this webhook is currently enabled.

Example:

true

secret
string | null

Optional shared secret used to sign webhook payloads.

Example:

"whsec_1234567890"

Response

Webhook created

Webhook created

success
enum<boolean>
required
Available options:
true
data
object
message
string
meta
object