These routes allow you to CRUD webhooks within Cal.com.
Webhook Object
| Attribute | Description |
|---|---|
| id | string The ID of the webhook, generated automatically |
| userId | integer The ID of the user associated with the webhook |
| teamId | integer The ID of the team associated with the webhook |
| eventTypeId | integer The ID of the event type associated with the webhook |
| platformOAuthClientId | string The ID of the platform OAuth Client |
| subscriberUrl | string The URL to which the webhook payload will be sent |
| payloadTemplate | string The template for the payload sent by the webhook |
| createdAt | DateTime The date and time when the webhook was created |
| active | boolean Indicates whether the webhook is active |
| eventTriggers | WebhookTriggerEvents[] The events that trigger the webhook |
| user | User Object The user associated with the webhook |
| team | Team Object The team associated with the webhook |
| eventType | EventType Object The event type associated with the webhook |
| platformOAuthClient | PlatformOAuthClient Object The Platform OAuth Client associated with the webhook |
| app | App Object The app associated with the webhook |
| appId | string The ID of the app associated with the webhook |
| secret | string The secret key used to verify the webhook's payload |
| platform | boolean Indicates whether the webhook is platform-wide |
| scheduledTriggers | WebhookScheduledTriggers[] Scheduled triggers associated with the webhook |
Webhook Object Example
{
"id": "asdad-21ed-sdasd1q2ea-dasd3123sadasdasdasxc",
"userId": 42,
"teamId": 7,
"eventTypeId": 101,
"subscriberUrl": "https://example.com/webhook-handler",
"payloadTemplate": "",
"createdAt": "2024-08-01T12:00:00Z",
"active": true,
"eventTriggers": [Event Triggers Enum[]],
"user": [User Object],
"team": [Team Object],
"eventType": [EventType Object],
"app": [App Object],
"appId": "app_123abc",
"secret": "shh_very_secret_key",
"platform": false,
"scheduledTriggers": [ScheduledTriggers Object[]]
}
Find all webhooks
GET
/webhooks
Create a new webhook
POST
/webhooks
Find a webhook
GET
/webhooks/{id}
Edit an existing webhook
PATCH
/webhooks/{id}
Delete a webhook
DELETE
/webhooks/{id}