Skip to main content
GET
Get Alert

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

alert_id
string
required

Response

Successful Response

id
string
required
type
enum<string>
required
Available options:
PATIENT_CREATED,
PATIENT_UPDATED,
APPOINTMENT_CANCELLED,
APPOINTMENT_UPDATED,
APPOINTMENT_REQUEST,
APPOINTMENT_SCHEDULED,
SELF_SCHEDULED_APPOINTMENT,
SELF_SCHEDULED_APPOINTMENT_CANCELLED,
SELF_SCHEDULED_APPOINTMENT_UPDATED,
BLOCK_CREATED,
BLOCK_CANCELLED,
BLOCK_UPDATED,
SHIFT_CREATED,
SHIFT_CANCELLED,
SHIFT_UPDATED,
PAYMENT_CREATED,
PAYMENT_FAILED,
PAYMENT_SUCCEEDED,
PLANNED_PAYMENT_FAILED,
PLANNED_PAYMENT_SUCCEEDED,
CHARGE_CREATED,
REFUND_CREATED,
REFUND_FAILED,
REFUND_SUCCEEDED,
ADJUSTMENT_CREATED,
ADJUSTMENT_FAILED,
ADJUSTMENT_SUCCEEDED,
INVOICE_UPDATED,
INVOICE_STATUS_UPDATE,
INVOICE_SET_UPDATED,
CHARGE_PAYMENT_CREATED,
CALL_RECEIVED,
CALL_MADE,
CALL_ONGOING,
MESSAGE_RECEIVED,
MESSAGE_SENT,
MESSAGE_DELIVERED,
MESSAGE_FAILED,
EMAIL_RECEIVED,
EMAIL_SENT,
MAIL_SENT,
MAIL_DELIVERY_FAILED,
FORM_SUBMITTED,
APPOINTMENT_CHECKLIST_FILLED_FORM,
APPOINTMENT_CHECKLIST_CHECKED_IN,
APPOINTMENT_CHECKLIST_WITH_MA,
APPOINTMENT_CHECKLIST_MEASUREMENT_TAKEN,
APPOINTMENT_CHECKLIST_DOSE_TAKEN,
APPOINTMENT_CHECKLIST_WITH_PROVIDER,
APPOINTMENT_CHECKLIST_NOTE_TAKEN,
APPOINTMENT_CHECKLIST_PAYMENT_MADE,
APPOINTMENT_CHECKLIST_REQUEST_GFE,
APPOINTMENT_CHECKLIST_PICTURE_TAKEN,
APPOINTMENT_CHECKLIST_CARE_PLAN,
NOTIFICATION,
LOW_PATIENT_REVIEW,
CHAT_UPDATE,
RAINFOREST_PAYIN_FAILED,
RAINFOREST_PAYIN_PROCESSING,
RAINFOREST_POS_PAYIN_CANCELLED,
RAINFOREST_DEPOSIT_IN_REVIEW,
RAINFOREST_DEPOSIT_SUCCEEDED,
RAINFOREST_DEPOSIT_FAILED,
STOCK_LOW,
STOCK_ADDED,
STOCK_ARCHIVED,
STOCK_LINKED_TO_ITEM,
STOCK_UNLINKED_FROM_ITEM,
STOCK_UPDATED,
STOCK_DRAWDOWN,
SHIPMENT_RECEIVED,
SHIPMENT_UPDATED,
SHIPMENT_ARCHIVED,
ITEM_CREATED,
ITEM_UPDATED,
ITEM_ARCHIVED,
INVENTORY_ACTION
data
Payment · object
required
createdDate
string<date-time>
required
occurances
integer
required
actionRequired
boolean
default:false
resolvedDate
string<date-time> | null
tags
TagTiny · object[]
assignedProvider
ProviderTiny · object | null
resolvingProvider
ProviderTiny · object | null
patient
UserTiny · object | null
callId
string | null
messageId
string | null
emailId
string | null
mailId
string | null
eventId
string | null
formId
string | null
invoiceId
string | null
paymentId
string | null
paymentMethodId
string | null
chargeId
string | null
adjustmentId
string | null
refundId
string | null
depositId
string | null