Axiym

Create webhook subscription

Registers a publicly reachable HTTPS endpoint for webhook deliveries. A subscription receives every event available to your partnership; per-event filters are not supported.

Store the returned subscriptionId so you can test or disable the subscription later.

View MarkdownView complete reference

Authorization

Default
AuthorizationBearer <token>

In: header

Header Parameters

X-Request-Id?string

Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in X-Request-Id, or generates one when omitted.

Formatuuid
Idempotency-Key*string

Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.

Lengthlength <= 255

Request Body

application/json

endpoint*string

Public HTTPS endpoint for webhook deliveries. Return 2xx after durably accepting each event.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json