Skip to main content
PATCH
Patch
Any mutable field: name, description, webhook_url, headers, payload_format, status. Setting status: "disabled" retains the webhook but stops deliveries.

Authorizations

api_key
string
header
required

Path Parameters

webhook_id
string
required

Body

application/json
headers
string[]
name
string
description
string
webhook_url
string<uri>
Required string length: 1 - 65536
payload_format
enum<string>

An enumeration.

Available options:
json,
stringified_json
status
enum<string>

An enumeration.

Available options:
active,
disabled

Response

Successful Response

This is base response model for all responses in partner service.

webhook_id
string
required
scope
WebhookScope · object
required
name
string
required
webhook_url
string
required
status
enum<string>
required

An enumeration.

Available options:
active,
disabled
created_at
string<date-time>
required
last_modified_time
string<date-time>
required
response_context
ResponseContext · object
required
description
string
headers
string[]
payload_format
enum<string>

An enumeration.

Available options:
json,
stringified_json
legacy
boolean