Skip to main content
PATCH

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication.

Path Parameters

​
id
string<uuid>
required

UUID of the connection webhook.

Body

application/json

Input serializer for PATCH /webhooks/{id}. At least one field required.

​
callback_url
string<uri>

New HTTPS URL for event delivery.

​
is_active
boolean

Pause (false) or resume (true) delivery.

Response

Updated.

Output serializer for GET / PATCH responses. Secret is never returned.

​
id
string<uuid>
required
read-only

Unique webhook identifier (UUID).

​
event_type
enum<string>
required

The event type this webhook is subscribed to.

  • connection.expiry_scheduled - Expiry Scheduled
Available options:
connection.expiry_scheduled
​
callback_url
string<uri>
required
read-only

HTTPS URL that signed events are POSTed to.

​
is_active
boolean
required
read-only

Whether the webhook is active. Inactive webhooks do not receive events.

​
created_at
string<date-time>
required
read-only

ISO 8601 timestamp when the webhook was created.

​
updated_at
string<date-time>
required
read-only

ISO 8601 timestamp when the webhook was last updated.