Sign in
latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Subscriptions & Webhooks

Create new subscription

post/subscriptions

Query parameters

skipWebhookboolean

Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks

Headers

x-organization-idinteger

Required if using a multi organizations token

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "type": "API_TOKEN_CREATED",
  "url": "https://example.com"
}

Response

Successfully created subscription

idinteger required

Global ID of the subscription

status'VALID' | 'PENDING_APPROVAL' required

Validation status of the subscription. Contact support if your subscription returns PENDING_APPROVAL before using the subscription.

secretstring

Secret to hash the Hmac signature

Example response

{
  "id": 963
}