v1

latestOpenAPI 3.0.0Proprietary2026-07-1313647393.0 KB
Partner Webhooks

Create a webhook for a sub-merchant

Create a webhook to receive events for a sub-merchant account. Maximum 30 webhooks per account. Authentication: OAuth access_token.

post/v2/accounts/{account_id}/webhooks

Path parameters

account_idstring required

Unique identifier of the linked merchant account (e.g. acc_00000000000001).

Request body

urlstring required
alert_emailstring
secretstring
activeboolean
eventsobject required

Response

Webhook created

idstring

Webhook ID, max 14 characters

entity'webhook'
owner_idstring
owner_typestring
urlstring

HTTPS URL to receive webhook events

alert_emailstring
secretstring

Shared secret for HMAC verification (write-only)

secret_existsboolean
activeboolean
eventsobject

Map of event names to boolean

servicestring
contextstring[]
disabled_atinteger
created_atinteger
updated_atinteger