Update Webhook

Update a webhook

put

Updates an existing webhook.

Authorizations

Bearer Token

AuthorizationstringRequired

Path parameters

webhookIdstringRequired

Header parameters

x-api-keystringRequired

Body

application/json

Contains details as input for creating or updating a webhook.

namestring · nullableOptional

The name of the webhook.

urlstring · nullableOptional

URL for the webhook to send events to.

eventTypesstring[] · nullableOptional

List of event types this webhook subscribes on.

enabledboolean · nullableOptional

Indicates the status of the webhook. If true events will be sent on the webhook, otherwise (false) event sendout is disabled.

Responses

200

Returns a updated webhook

application/json

Contains details about a webhook.

namestring · nullableOptional

The name of the webhook.

urlstring · nullableOptional

URL for the webhook to send events to.

eventTypesstring[] · nullableOptional

List of event types this webhook subscribes on.

enabledboolean · nullableOptional

Indicates the status of the webhook. If true events will be sent on the webhook, otherwise (false) event sendout is disabled.

idstring · uuidOptional

The webhook id.

400

Bad request

403

Forbidden due to insufficient privileges

put

/v1/webhooks/{webhookId}

HTTPcURLJavaScriptPython

PUT /v1/webhooks/{webhookId} HTTP/1.1
Authorization: YOUR_API_KEY
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 110

{
  "name": "text",
  "url": "text",
  "eventTypes": [
    "text"
  ],
  "enabled": true,
  "headers": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "name": "text",
  "url": "text",
  "eventTypes": [
    "text"
  ],
  "enabled": true,
  "headers": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000"
}