Skip to main content
POST

Headers

string
required
Target API version (e.g. 1.2).

Request Body Parameters

string
required
Publicly accessible HTTPS destination URL where webhook event payloads will be delivered (e.g. https://example.com/webhook).
array of numbers
required
Array of numeric event IDs to subscribe to (e.g. [13, 14, 15] obtained from the Get Webhook Events endpoint).

Response Body

boolean
Indicates whether the webhook subscription was created successfully (true).
number
Unique identifier assigned to this webhook subscription.
string
The registered HTTPS callback endpoint URL.
string
Cryptographic secret key used to compute and verify the HMAC signature of incoming webhook delivery payloads. Store securely.
array of numbers
List of event IDs that are subscribed to this webhook endpoint.

Response Codes

Last modified on November 10, 2026