Webhook subscriptions

Create a webhook subscription

The response includes the signing secret exactly once — store it; it cannot be retrieved again. A subscription is scoped to a single clinicId.

post/api/webhooksubscriptions

Request

  • Base URL: https://api.veterical.com
  • URL: https://api.veterical.com/api/webhooksubscriptions
  • Auth: API key in header Authorization

Request body

clinicIdstring required
urlstring required
eventsstring[]

Empty array subscribes to all events

Example request

{
  "url": "https://example.com/veterical-webhook"
}

Response

The created subscription, including its secret

Changes

No recorded changes to this operation across all 1 revision of this API.