Webhooks

Get a webhook

Changed on
get/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_

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

  • v216de9d3eb7b3Revision changes
    • info

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

  • v2b08d7bb5d881Revision changes
    • 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