PATCH
/
webhooks
/
{id}
curl --request PATCH \
  --url https://api.cal.com/v1/webhooks/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "subscriberUrl": "<string>",
  "eventTriggers": "BOOKING_CREATED",
  "active": true,
  "payloadTemplate": "<string>",
  "eventTypeId": 123,
  "secret": "<string>"
}'

Authorizations

​
apiKey
string
query
required

Path Parameters

​
id
integer
required

Numeric ID of the webhook to edit

Query Parameters

​
apiKey
string
required

Your API key

Body

application/json
Edit an existing webhook
​
subscriberUrl
string

The URL to subscribe to this webhook

​
eventTriggers
enum<string>

The events which should trigger this webhook call

Available options:
BOOKING_CREATED,
BOOKING_RESCHEDULED,
BOOKING_CANCELLED,
MEETING_ENDED
​
active
boolean

Whether the webhook is active and should trigger on associated trigger events

​
payloadTemplate
string

The template of the webhook's payload

​
eventTypeId
number

The event type ID if this webhook should be associated with only that event type

​
secret
string

The secret to verify the authenticity of the received payload

Response

201

OK, webhook edited successfully

Was this page helpful?

Suggest editsRaise issue