Create Subscription | Account API 0.2.0

Authorization

Default

AuthorizationBearer <token>

In: header

Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the X-Request-Id response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

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`

Request builder

Request and response examples

curl -X POST "https://example.com/webhooks/subscriptions" \  -H "Content-Type: application/json" \  -d '{    "endpoint": "string"  }'

{  "subscriptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  "endpoint": "https://api.acme.example/webhooks"}

Authorization

Header Parameters

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

422application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`