Webhooks
Webhook Create
Webhooks
Webhook Create
Create a new Webhook for the Tenant
POST
Headers
The tenant you are making this request on behalf of
Your api key
Body
application/json
List of event types the webhook subscribes to.
Available options:
PATIENT_CREATED, PATIENT_UPDATED, APPOINTMENT_CANCELLED, APPOINTMENT_RESCHEDULED, APPOINTMENT_REQUEST, PAYMENT_CREATED, PAYMENT_FAILED, PAYMENT_SUCCEEDED, CHARGE_CREATED, REFUND_CREATED, REFUND_FAILED, REFUND_SUCCEEDED, ADJUSTMENT_CREATED, ADJUSTMENT_FAILED, ADJUSTMENT_SUCCEEDED, INVOICE_SENT, INVOICE_FAILED, CALL_RECEIVED, CALL_MADE, MESSAGE_RECIEVED, MESSAGE_SENT, MESSAGE_DELIVERED, MESSAGE_FAILED, EMAIL_RECIEVED, EMAIL_SENT, FORM_SUBMITTED, MAIL_SENT, MAIL_DELIVERY_FAILED The URL where the webhook will send notifications.
Email address for sending notifications about delivery failures.
Response
200 - application/json
The date and time when the webhook was created.
Unique identifier for the webhook.
The secret key used for signing the webhook payloads.
List of event types the webhook is subscribed to.
Available options:
PATIENT_CREATED, PATIENT_UPDATED, APPOINTMENT_CANCELLED, APPOINTMENT_RESCHEDULED, APPOINTMENT_REQUEST, PAYMENT_CREATED, PAYMENT_FAILED, PAYMENT_SUCCEEDED, CHARGE_CREATED, REFUND_CREATED, REFUND_FAILED, REFUND_SUCCEEDED, ADJUSTMENT_CREATED, ADJUSTMENT_FAILED, ADJUSTMENT_SUCCEEDED, INVOICE_SENT, INVOICE_FAILED, CALL_RECEIVED, CALL_MADE, MESSAGE_RECIEVED, MESSAGE_SENT, MESSAGE_DELIVERED, MESSAGE_FAILED, EMAIL_RECIEVED, EMAIL_SENT, FORM_SUBMITTED, MAIL_SENT, MAIL_DELIVERY_FAILED The URL where the webhook sends notifications.
Email address for sending notifications about delivery failures.
The date and time when the webhook was last updated.