Webhooks

Webhooks allow you to subscribe to events across your projects and sync the data from the events with other systems.

get

List webhooks

List all webhooks in a project

Required attributes

projectId

string

Your projectId

Optional attributes

None

Request

get

/api/projects/:projectId/webhooks

Response

get

Retrieve a webhook

Retrieves a single webhook based on the provided webhook ID

Required attributes

projectId	string	Your project ID
webhookId	string	The ID of the webhook to retrieve

Optional attributes

None

Request

get

/api/projects/:projectId/webhooks/:webhookId

Response

post

Create a webhook

Creates a new webhook

Required attributes

projectId

string

Your project ID

Optional attributes

title	string	The name of the new webhook
description	string	A description for the new webhook
enabled	boolean	Enable or disable the webhook
resource	string	The resource to subscribe to events for
actions	string[]	The actions on the resource to subscribe to
conditions	conditionsObject[]	An array of webhook conditions to apply to the webhook
endpoints	string[]	An array of endpoint IDs to attach to the webhook

Request

post

/api/projects/:projectId/webhooks

Response

patch

Update a webhook

Updates attributes for a webhook.

Required attributes

projectId	string	Your project ID
webhookId	string	The ID of the webhook to update

Optional attributes

title	string	The name of the new webhook
description	string	A description for the new webhook
enabled	boolean	Enable or disable the webhook
resource	string	The resource to subscribe to events for
actions	string[]	The actions on the resource to subscribe to
conditions	conditionsObject[]	An array of webhook conditions to apply to the webhook
endpoints	string[]	An array of endpoint IDs to attach to the webhook

Request

patch

/api/projects/:projectId/webhooks/:webhookId

Response

delete

Delete a webhook

Deletes a webhook.

Required attributes

projectId	string	Your project ID
webhookId	string	The ID of the webhook to remove

Optional attributes

None

Request

delete

/api/projects/:projectId/webhooks/:webhookId

Response

get

List webhook endpoints

Lists available endpoints to send webhook data to

Required attributes

projectId

string

Your projectId

Optional attributes

None

Request

get

/api/projects/:projectId/webhooks/endpoints

Response

get

Retrieve a webhook endpoint

Fetches a single webhook endpoint based on the provided endpoint ID

Required attributes

projectId

string

Your projectId

Optional attributes

endpointId

string

The ID of the endpoint to fetch

Request

get

/api/projects/:projectId/webhooks/endpoints/:endpointId

Response

post

Create a webhook endpoint

Creates a new webhook endpoint

Required attributes

projectId	string	Your projectId
title	string	Title or name of the webhook endpoint
type	string	Endpoint type. Currently, only "https" is supported.
url	string	The URL of the endpoint the webhook will send data to

Optional attributes

headers

string

Stringified JSON object of the headers to send with the webhook request to the endpoint

Request

post

/api/projects/:projectId/webhooks/endpoints

Response

patch

Update a webhook endpoint

Updates attributes for a webook endpoint

Required attributes

projectId	string	Your projectId
endpointId	string	The ID of the webhook endpoint to update

Optional attributes

title	string	Title or name of the webhook endpoint
type	string	Endpoint type. Currently, only "https" is supported.
url	string	The URL of the endpoint the webhook will send data to
headers	string	Stringified JSON object of the headers to send with the webhook request to the endpoint

Request

patch

/api/projects/:projectId/webhooks/endpoints/:endpointId

Response

delete

Delete a webhook endpoint

Required attributes

projectId	string	Your projectId
endpointId	string	The ID of the webhook endpoint to delete

Optional attributes

None

Request

delete

/api/projects/:projectId/webhooks/endpoints/:endpointId

Response

patch

Attach an endpoint to a webhook

Attaches an endpoint to a webhook

Required attributes

projectId	string	Your projectId
webhookId	string	The ID of the webhook to update
endpoints	string[]	An array of endpoint IDs to associate with the webhook

Optional attributes

None

Request

patch

/api/projects/:projectId/webhooks/:webhookId

Response

patch

Detach an endpoint from a webhook

Detaches and endpoint from a webhook without deleting the endpoint.

Required attributes

projectId	string	Your projectId
webhookId	string	The ID of the webhook to update
endpoints	string[]	An array of endpoint IDs to associate with the webhook

Optional attributes

None

Request

patch

/api/projects/:projectId/webhooks/:webhookId

Response

Last modified 7/6/2024, 5:26:10 PM