Webhooks

Update a webhook

Changed on
patch/v2/webhooks/{webhookId}

Request

  • The document declares no server URL.
  • Auth: none declared. Required headers: Authorization

Path parameters

webhookIdstring required

Headers

Authorizationstring required

value must be Bearer <token> where <token> is api key prefixed with cal_

Request body

payloadTemplatestring

The template of the payload that will be sent to the subscriberUrl, check cal.com/docs/core-features/webhooks for more information

activeboolean
subscriberUrlstring
triggersstring[]
secretstring
version'2021-10-20'

The version of the webhook

Example request

{
  "payloadTemplate": "{\"content\":\"A new event has been scheduled\",\"type\":\"{{type}}\",\"name\":\"{{title}}\",\"organizer\":\"{{organizer.name}}\",\"booker\":\"{{attendees.0.name}}\"}",
  "triggers": [
    "BOOKING_CREATED",
    "BOOKING_RESCHEDULED",
    "BOOKING_CANCELLED",
    "BOOKING_CONFIRMED",
    "BOOKING_REJECTED",
    "BOOKING_COMPLETED",
    "BOOKING_NO_SHOW",
    "BOOKING_REOPENED"
  ],
  "version": "2021-10-20"
}

Response

status'success' | 'error' required

Example response

{
  "status": "success",
  "data": {
    "payloadTemplate": "{\"content\":\"A new event has been scheduled\",\"type\":\"{{type}}\",\"name\":\"{{title}}\",\"organizer\":\"{{organizer.name}}\",\"booker\":\"{{attendees.0.name}}\"}"
  }
}

Changes

    • breaking

      removed the enum value ROUTING_FORM_FALLBACK_HIT of the request property /

    • info

      removed the ROUTING_FORM_FALLBACK_HIT enum value from the // response property for the response status

    • breaking

      removed the enum value AFTER_GUESTS_CAL_VIDEO_NO_SHOW of the request property

    • breaking

      removed the enum value AFTER_HOSTS_CAL_VIDEO_NO_SHOW of the request property

    • breaking

      removed the enum value BOOKING_CANCELLED of the request property

    • breaking

      removed the enum value BOOKING_CREATED of the request property

    • breaking

      removed the enum value BOOKING_NO_SHOW_UPDATED of the request property

    • breaking

      removed the enum value BOOKING_PAID of the request property

    • breaking

      removed the enum value BOOKING_PAYMENT_INITIATED of the request property

    • breaking

      removed the enum value BOOKING_REJECTED of the request property

    • breaking

      removed the enum value BOOKING_REQUESTED of the request property

    • breaking

      removed the enum value BOOKING_RESCHEDULED of the request property

    • breaking

      removed the enum value DELEGATION_CREDENTIAL_ERROR of the request property

    • breaking

      removed the enum value FORM_SUBMITTED of the request property

    • breaking

      removed the enum value FORM_SUBMITTED_NO_EVENT of the request property

    • breaking

      removed the enum value INSTANT_MEETING of the request property

    • breaking

      removed the enum value MEETING_ENDED of the request property

    • breaking

      removed the enum value MEETING_STARTED of the request property

    • breaking

      removed the enum value OOO_CREATED of the request property

    • breaking

      removed the enum value RECORDING_READY of the request property

    • breaking

      removed the enum value RECORDING_TRANSCRIPTION_GENERATED of the request property

    • breaking

      removed the enum value WRONG_ASSIGNMENT_REPORT of the request property

    • breaking

      the request property type changed from string to array

    • breaking

      the // response's property type changed from object to string for status

    • warning

      added the new AFTER_GUESTS_CAL_VIDEO_NO_SHOW enum value to the // response property for the response status

    • warning

      added the new AFTER_HOSTS_CAL_VIDEO_NO_SHOW enum value to the // response property for the response status

    • warning

      added the new BOOKING_CANCELLED enum value to the // response property for the response status

    • warning

      added the new BOOKING_CREATED enum value to the // response property for the response status

    • warning

      added the new BOOKING_NO_SHOW_UPDATED enum value to the // response property for the response status

    • warning

      added the new BOOKING_PAID enum value to the // response property for the response status

    • warning

      added the new BOOKING_PAYMENT_INITIATED enum value to the // response property for the response status

    • warning

      added the new BOOKING_REJECTED enum value to the // response property for the response status

    • warning

      added the new BOOKING_REQUESTED enum value to the // response property for the response status

    • warning

      added the new BOOKING_RESCHEDULED enum value to the // response property for the response status

    • warning

      added the new DELEGATION_CREDENTIAL_ERROR enum value to the // response property for the response status

    • warning

      added the new FORM_SUBMITTED enum value to the // response property for the response status

    • warning

      added the new FORM_SUBMITTED_NO_EVENT enum value to the // response property for the response status

    • warning

      added the new INSTANT_MEETING enum value to the // response property for the response status

    • warning

      added the new MEETING_ENDED enum value to the // response property for the response status

    • warning

      added the new MEETING_STARTED enum value to the // response property for the response status

    • warning

      added the new OOO_CREATED enum value to the // response property for the response status

    • warning

      added the new RECORDING_READY enum value to the // response property for the response status

    • warning

      added the new RECORDING_TRANSCRIPTION_GENERATED enum value to the // response property for the response status

    • warning

      added the new ROUTING_FORM_FALLBACK_HIT enum value to the // response property for the response status

    • warning

      added the new WRONG_ASSIGNMENT_REPORT enum value to the // response property for the response status