POST
/
v1
/
webhook
/
create

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json
notificationEmail
string | null

Email address for sending notifications about delivery failures.

subscriptions
enum<string>[]
required

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_RECIEVED,
CALL_MADE,
MESSAGE_RECIEVED,
MESSAGE_SENT,
MESSAGE_DELIVERED,
MESSAGE_FAILED,
EMAIL_RECIEVED,
EMAIL_SENT,
FORM_SUBMITTED,
MAIL_SENT,
MAIL_DELIVERY_FAILED
url
string
required

The URL where the webhook will send notifications.

Response

200 - application/json
createdDate
string
required

The date and time when the webhook was created.

id
string
required

Unique identifier for the webhook.

notificationEmail
string | null

Email address for sending notifications about delivery failures.

secret
string
required

The secret key used for signing the webhook payloads.

subscriptions
enum<string>[]
required

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_RECIEVED,
CALL_MADE,
MESSAGE_RECIEVED,
MESSAGE_SENT,
MESSAGE_DELIVERED,
MESSAGE_FAILED,
EMAIL_RECIEVED,
EMAIL_SENT,
FORM_SUBMITTED,
MAIL_SENT,
MAIL_DELIVERY_FAILED
updatedDate
string | null

The date and time when the webhook was last updated.

url
string
required

The URL where the webhook sends notifications.

Rule Set ListWebhook Get