Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer API key for external client access. Live keys use the sk_ prefix; test keys use the sk_test_ prefix and support order-lifecycle testing with mock responses without processing or credit usage.

Body

application/json
url
string<uri>
required

Webhook endpoint URL

Example:

"https://example.com/webhook"

name
string

Webhook name (for identification)

Maximum string length: 100
isTest
boolean

Endpoint mode. For a test API key, omit this field or use true; false returns AUTH_FORBIDDEN. Live API keys may choose either mode.

Response

Webhook created successfully

data
object