Sign in

v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB
Webhooks

Register Webhook

Registers a new webhook triggered by specific events. Each webhook is linked to a business_id, client_id, endpoint, and event_names defining the events that trigger it. The service sends POST requests to the specified URL for these events. The URL must be reachable and preferably secure (HTTPS). Optionally, a signing key can be provided to verify webhook payload authenticity.

post/notification/v1/connect/webhook/subscriptions

Request body

event_namesstring[]

Specifies the type of events that will trigger the webhook.

  • "appointment.created": Trigger on appointment create events.
  • "user.delete": Trigger on user delete events.
endpointstring required

The fully qualified URL where the webhook will send POST requests. The URL must be reachable by the webhook service.

signing_keystring

A secret key provided by the client for verifying the authenticity of webhook payloads. It should be a securely generated, random string.

protocolstring

Specifies the protocol or delivery mechanism used for the webhook.

  • "http": Plain HTTP endpoint.
  • "https": Secure HTTPS endpoint.
  • "SQS endpoint": AWS SQS queue URL for message delivery.
  • "Lambda function": AWS Lambda function ARN for direct invocation.

Example request

{
  "event_names": [
    "appointment.created",
    "appointment.updated",
    "prescription.created",
    "prescription.updated",
    "receipt.created",
    "receipt.updated"
  ],
  "endpoint": "https://example.com/webhook",
  "signing_key": "supersecretkey",
  "protocol": "https"
}

Response

Webhook registered successfully.

idstring

The unique identifier for the webhook.

statusstring

A message indicating the status of the response.

Example response

{
  "id": "7",
  "status": "success"
}