Skip to content

Register a new webhook endpoint for the merchant business. Returns the generated signing secret — shown only once and must be stored securely.

POST
/v1/webhooks/endpoints
Idempotency-Key
string

Required on every mutating /v1/* endpoint (Phase 1 fixture relaxes to optional)

object
url
required
string format: uri
secret
string
>= 16 characters
enabled_events
Array<string>
default: *
active
boolean
default: true
metadata
object
key
additional properties
object
success
required
boolean
data
required
object
id
required
string
url
required
string
secret
required
string
enabled_events
required
active
required
boolean
metadata
required
meta
required
object
requestId
required
string