Sign in

v4

latestOpenAPI 3.0.02026-08-04109113304.5 KB
Webhooks

Update a Webhook

Update a webhook by ID

patch/webhooks/{webhook_id}

Path parameters

webhook_idinteger required

The webhook identifier

Request body

descriptionstring required

A short description of the Webhook.

eventsstring[] required

List of events subscribed to the webhook.

namestring required

Name of the Webhook.

urlstring required

Webhook URL

Example request

{
  "description": "Webhook description"
}

Response

Return updated Webhook info

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"
}