Axiym

Create webhook subscription

Registers an HTTPS endpoint to receive account, address book, and withdrawal notifications.

Your endpoint must be publicly reachable and return a 2XX response to the webhook POST request.

View MarkdownView complete reference

Authorization

Default
AuthorizationBearer <token>

In: header

Header Parameters

X-Request-Id?string

Optional client-generated request identifier (UUID recommended) for end-to-end tracing.

Axiym echoes it in the X-Request-Id response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.

Formatuuid
Idempotency-Key*string

Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.

Repeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.

Lengthlength <= 255

Request Body

application/json

endpoint*string

URL of the endpoint to subscribe to notifications. Must be publicly accessible, use HTTPS, and respond with a 2XX status to a POST request.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json