Skip to main content
PATCH
Update a webhook endpoint

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

Serializer for WebhookEndpoint model.

url
string<uri>

HTTPS URL where webhook notifications will be sent

Required string length: 1 - 2048
enabled
boolean

Whether this webhook endpoint is active

events
any

List of event types this webhook will receive

access_mode
enum<string>

Whether this webhook receives test or production events

  • test - Test
  • production - Production
Available options:
test,
production
description
string

Optional description or label for this webhook

Maximum string length: 255
max_consecutive_failures
integer

Webhook will be auto-disabled after this many consecutive failures

Required range: -2147483648 <= x <= 2147483647

Response

200 - application/json

Serializer for WebhookEndpoint model.

id
string<uuid>
required
read-only
url
string<uri>
required

HTTPS URL where webhook notifications will be sent

Maximum string length: 2048
consecutive_failures
integer
required
read-only
last_failure_at
string<date-time>
required
read-only
created
string<date-time>
required
read-only
updated
string<date-time>
required
read-only
deliveries_url
string<uri>
required
read-only
enabled
boolean

Whether this webhook endpoint is active

events
any

List of event types this webhook will receive

access_mode
enum<string>

Whether this webhook receives test or production events

  • test - Test
  • production - Production
Available options:
test,
production
description
string

Optional description or label for this webhook

Maximum string length: 255
max_consecutive_failures
integer

Webhook will be auto-disabled after this many consecutive failures

Required range: -2147483648 <= x <= 2147483647