Sign in

v4

latestOpenAPI 3.0.02026-08-04109113304.5 KB
Webhooks

Get Webhooks by Project

Get all of the Webhooks that have been created in a given Project

get/projects/{project_id}/webhooks

Path parameters

project_idinteger required

The project identifier

Query parameters

per_pageinteger

Optional pagination argument that specifies the maximum number of objects to return per request

page_windowinteger

Number of previous and next page links to supply for the request (defaults to 1).

page_tokenstring

Pagination page token. Implements prev, next, last, first

Response

Return all Webhooks in a specified Project

activeboolean

Is Webhook active.

createdstring

Created time.

descriptionstring

A short description of the Webhook.

eventsstring[]

List of events subscribed to the webhook.

idstring

ID of this Webhook

last_modifiedstring

Last modification time.

namestring required

Name of the Webhook.

project_idinteger required

ID of the project of the Environment.

urlstring required

Webhook URL

Example response

[
  {
    "description": "Webhook description"
  }
]