Get a webhook

GET /v2/oauth-clients/{clientId}/webhooks/{webhookId}

Try it

Get a webhook

cURL

curl --request GET \
  --url https://api.cal.com/v2/oauth-clients/{clientId}/webhooks/{webhookId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-cal-secret-key: <x-cal-secret-key>'

200

{
  "status": "success",
  "data": {
    "payloadTemplate": "{\"content\":\"A new event has been scheduled\",\"type\":\"{{type}}\",\"name\":\"{{title}}\",\"organizer\":\"{{organizer.name}}\",\"booker\":\"{{attendees.0.name}}\"}",
    "oAuthClientId": "<string>",
    "id": 123,
    "triggers": [
      {}
    ],
    "subscriberUrl": "<string>",
    "active": true,
    "secret": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-cal-secret-key · string · required

OAuth client secret key

Response

200 - application/json

status · enum<string> · required

Available options: success, error

Example:

"success"

data · object · required

Show child attributes

data. payloadTemplate · string · required

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

Example:

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

data. oAuthClientId · string · required

data. id · number · required

data. triggers · object[] · required

data. subscriberUrl · string · required

data. active · boolean · required

data. secret · string