Skip to main content
POST
Create a webhook endpoint

Authorizations

X-Suby-Api-Key
string
header
required

Secret API key. sk_live_… (production) or sk_sandbox_… (sandbox).

Body

application/json
url
string<uri>
required

Destination URL (http/https). Required.

Maximum string length: 2048
Pattern: ^https?://
description
string

Optional label.

Maximum string length: 500
enabledEvents
string[]

Event types to receive (e.g. payment.succeeded, subscription.updated). Empty array = subscribe to ALL events (default).

Response

Endpoint created (with plaintext secret)

success
boolean
required
Example:

true

data
object
required

Endpoint-specific payload.

message
string