Subscribing and Managing Subscriptions

You can manage subscriptions through the webhook subscription endpoints in the API:

• Create a webhook subscription
  • Create a subscription with a callback_url and an events array.
  • The response returns a secret — see Verify the signature.
    ⚠️ This secret is shown only once, at creation, and cannot be retrieved later so please store it securely.
• List webhook subscriptions
• Get a webhook subscription
  • List / Get subscriptions to inspect their status (enabled, disabled_at, disabled_reason, last_failure_status, consecutive_failures, etc).
• Update a webhook subscription
  • Update a subscription to change its callback URL or events, or to enable/disable it.
• Delete a webhook subscription
  • Delete a subscription to stop deliveries permanently.

Whether an operation is company-scoped or app-wide follows from your token: a company-bound token acts only on its own company's subscriptions, while a firm token acts on all the subscriptions it owns regardless of company; a client-credentials token is not bound to any company, so subscriptions it creates are always app-wide, and listing returns all subscriptions for the subscriber regardless of company.

See Subscriber types & company scoping for details.