Skip to main content
POST
Create subscription

Authorizations

API-KEY
string
header
required

Your partner API key. Requires the webhooks permission, or events for the PULL feed.

Headers

Api-Version
string
default:2026-09.1
required

The API version this request targets. Required on every /api/v0/* call. Format YYYY-MM.<release>; 2026-09.1 is the latest. The version that served the request is echoed back on the response. Missing, malformed or unsupported values are rejected with 400.

Pattern: ^\d{4}-\d{2}\.\d+$

Body

application/json
deliveryMode
enum<string>
default:PUSH
Available options:
PUSH,
PULL
target
string

The HTTPS endpoint Endl signs and POSTs every matching event to. Required for PUSH, and must be absent for PULL. Maximum 512 characters. Stored in canonical form — read data.target back rather than assuming your spelling was kept.

Maximum string length: 512
eventFilter
string[]

Which event types to receive. Defaults to ["*"]. At most 50 entries, each non-blank and at most 128 characters. An entry is *, an exact type, or one trailing wildcard such as payout.*.

Patterns are trimmed, lowercased, and underscores folded to dots — so PAYOUT_COMPLETED and payout.completed mean the same thing.

Maximum array length: 50
schemaVersion
string
default:2026-09.1

The payload shape every delivery on this subscription is rendered and signed in. Defaults to 2026-09.1, the only implemented version. Matched exactly and never trimmed. Immutable afterwards. At most 16 characters.

Maximum string length: 16

Response

Created. This response carries the signing secret.

code
integer

The HTTP status, repeated in the body.

message
string

A human-readable summary.

status
enum<string>

SUCCESS on a 2xx.

Available options:
SUCCESS,
ERROR
data
object
errors
object[]

Empty on success.