Skip to main content
POST
Set Up or Update Your Webhook

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Create a new webhook endpoint on the platform.

url
string
required

HTTPS URL that will receive webhook POST requests.

Required string length: 1 - 2048
Example:

"https://example.com/webhooks"

events
string[]

Individual event types to subscribe to. An empty list subscribes to all events.

Example:
event_groups
string[]

Event groups to subscribe to (e.g. 'payment', 'wallet'). Expanded into individual event types and merged with events.

Example:
description
string | null

Optional human-readable description for the webhook endpoint.

Maximum string length: 255
Example:

"Production payment notifications"

Response

Your webhook after this update. secret is present only on first setup.

Standard response wrapper for single-object responses and errors.

Generic over the payload type. A route that declares CommonResponse[SomeModel] gets the real data schema rendered in OpenAPI/Swagger; a bare CommonResponse leaves data untyped.

status_code
integer
required

HTTP status code for the response.

data
any
required

Payload or error details.

query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.