Skip to main content
PATCH
Update Webhook Subscription

Headers

source
string | null
X-API-SIGNATURE
string
required

Signature header

X-API-TIMESTAMP
integer
required

Timestamp header

X-API-NONCE
string
required

Nonce header

X-API-SUBSCRIPTION-KEY
string
required

Account ID header

Path Parameters

subscription_id
string<uuid>
required

Body

application/json

Schema to deserialize the webhook subscription update request.

callback_url
string<uri> | null

New HTTPS endpoint to deliver events to

Required string length: 1 - 2083
Example:

"https://example.com/webhooks/indx-v2"

description
string | null

Updated friendly label for this subscription

Example:

"<string>"

status
enum<string> | null

Enable or pause delivery without deleting the subscription

Available options:
active,
disabled

Response

Successful Response

message
string
required
data
WebhookResponse · object | null

Schema to serialize the webhook data.