SavvyCal API
Endpoints
Resources
Webhooks
SavvyCal API
Home

Webhooks

Endpoints for creating, reading, and deleting webhooks.

List Webhooks

This endpoint allows you to list your webhooks.

GET
/v1/webhooks

Parameters

Name Type Description
before string A pagination cursor for entries before a specific point in the collection.
after string A pagination cursor for entries after a specific point in the collection.
limit integer The maximum number of entries to retrieve (defaults to 20, up to 100 allowed).

Response

200
OK

When successful, returns a Paginated List of Webhook resources.

{
"entries": [
// items
],
"metadata": {
"before": nil,
"after": "g3QAAAABZAACaWRiAAAbFA==",
"limit": 20
}
}

Get Webhook

This endpoint allows you to fetch a single webhook.

GET
/v1/webhooks/:webhook_id

Response

200
OK

When successful, returns a Webhook resource.

{
"id": "wh_01ED74HMFGVZ92YVCWTD8Y8H6X",
// ...
}
404
Not Found

It the resource does not exist or is not accessible, returns a not found response.

Create Webhook

This endpoint allows you to create a new webhook.

POST
/v1/webhooks

Parameters

Name Type Description
url string The URL to receive HTTP POST requests.

Response

201
Created

When successful, returns the Webhook resource.

{
"id": "wh_01ED74HMFGVZ92YVCWTD8Y8H6X",
// ...
}
422
Unprocessible Entity

If the URL provided is not valid, returns validation errors.

{
"errors": {
"url": ["must be a valid URL"]
}
}

Delete Webhook

This endpoint allows you to delete a new webhook.

DELETE
/v1/webhooks/:webhook_id

Response

200
OK

When successful, returns the Webhook resource.

{
"id": "wh_01ED74HMFGVZ92YVCWTD8Y8H6X",
"state": "deleted"
// ...
}