Register Webhook
Registers a new webhook triggered by specific events. Each webhook is linked to a business_id
, client_id
, endpoint
, and scopes
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.
Authorizations
The API requires a Bearer token in the Authorization header for authentication.
Body
The fully qualified URL where the webhook will send POST requests. The URL must be reachable by the webhook service.
"https://example.com/webhook"
Specifies the type of events that will trigger the webhook.
- "all": Trigger on all events.
- "appointment.created": Trigger on appointment create events.
- "user.delete": Trigger on user delete events.
[
"appointment.created",
"appointment.updated",
"prescription.created",
"prescription.updated"
]
A secret key provided by the client for verifying the authenticity of webhook payloads. It should be a securely generated, random string.
"supersecretkey"
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.
"https"