Webhooks

These routes allow you to CRUD webhooks within Cal.com.

Find all webhooks

Finds all webhooks

GET http://localhost:3002/v1/hooks

200: OK OK

{
    // Response
}

401: Unauthorized Authorization information is missing or invalid.

{
    // Response
}

404: Not Found No webhooks were found

{
    // Response
}

Create a new webhook

Creates a new webhook

POST http://localhost:3002/v1/hooks

Request Body

Name	Type	Description
id*	String	UUID v4, identifies the webhook
eventTriggers*	ENUM	["BOOKING_CREATED", "BOOKING_RESCHEDULED", "BOOKING_CANCELLED"']
subscriberUrl*	String	A valid webhook subscriber URL
active*	Boolean	The state of the webhook being created
eventTypeId	Number	Event type ID to associate the webhook with
appId	Number	App ID to associate the webhook with
payloadTemplate	String	A template to customize the webhook payload

201: Created OK, webhook created

{
    // Response
}

400: Bad Request Bad request. Webhook body is invalid.

{
    // Response
}

401: Unauthorized Authorization information is missing or invalid.

{
    // Response
}

Find a webhook

Find a webhook from id

GET http://localhost:3002/v1/hooks/{id}

Path Parameters

Name	Type	Description
id*	String	ID of the webhook to find

200: OK Ok

{
    // Response
}

401: Unauthorized Authorization information is missing or invalid.

{
    // Response
}

404: Not Found Webhook was not found

{
    // Response
}

Edit an existing webhook

Edit an existing webhook identified by id

PATCH http://localhost:3002/v1/hooks/{id}

Path Parameters

Name	Type	Description
id*	String	ID of the webhook to edit

Request Body

Name	Type	Description
eventTrigger	ENUM	["BOOKING_CREATED", "BOOKING_RESCHEDULED", "BOOKING_CANCELLED"']
payloadTemplate	String	A template to customize the webhook payload
subscriberUrl	String	A valid webhook subscriber URL

201: Created OK, webhook edited successfuly

{
    // Response
}

400: Bad Request Bad request. Webhook body is invalid.

{
    // Response
}

401: Unauthorized Authorization information is missing or invalid.

{
    // Response
}

Delete a webhook

Deletes a webhook identified by id

DELETE http://localhost:3002/v1/hooks/{id}

Path Parameters

Name	Type	Description
id*	String	Id of the webhook to delete

201: Created OK, webhook removed successfuly

{
    // Response
}

400: Bad Request Bad request. Webhook id is invalid.

{
    // Response
}

401: Unauthorized Authorization information is missing or invalid.

{
    // Response
}