Skip to main content
PATCH
Update a webhook config

Authorizations

x-api-key
string
header
required

Merchant API key (e.g., sk_live_xxx or sk_test_xxx)

Path Parameters

id
string
required

Webhook config UUID

Example:

"68f11209-451f-4a15-bfcd-d916eb8b09f4"

Body

application/json
url
string

Webhook endpoint URL

Example:

"https://example.com/webhooks"

events
enum<string>[]

Event types to subscribe to

Available options:
order.created,
order.paid,
order.cancelled,
stock.low,
payment.created,
payment.completed,
payment.failed,
collection.pending,
collection.completed,
collection.failed,
withdrawal.created,
withdrawal.completed,
withdrawal.failed,
transaction.updated,
transfer.pending,
transfer.completed,
transfer.failed,
settlement.completed
Example:
isActive
boolean

Whether the webhook is active

Example:

true

Response

200 - application/json

Webhook config updated

status
boolean
required

Request success status

Example:

true

message
string
required

Response message

Example:

"Operation completed successfully"

data
object