Event Based Webhook

This section documents event-based webhook payloads.

📄️ Create Case

The CREATE_CASE event is triggered whenever new case ha been created.

📄️ Change Case Status

The CHANGECASESTATUS event is triggered whenever new case ha been created.

📄️ Add Case Comment

The ADDCASECOMMENT event is triggered whenever new comment are added to a case. This webhook provides a full snapshot of the case, the new comment, and details about the activity that triggered the event.

📄️ Delete Case Comment

The DELETECASECOMMENT event is triggered whenever any comment are deleted to a case. This webhook provides a full snapshot of the case, the new comment, and details about the activity that triggered the event.

📄️ Add Case Assignee

The ADDCASEASSIGNEE event is triggered whenever one or more assignees are added to a case. This webhook provides a full snapshot of the case, the current assignees, and details about the activity that triggered the event.

📄️ Remove Case Assignee

The REMOVECASEASSIGNEE event is triggered whenever one or more assignees are removed from a case. This webhook provides a full snapshot of the case, the current assignees, and details about the activity that triggered the event.

📄️ Add Case Attachments

The ADDCASEATTACHMENT event is triggered whenever new attachment added in the case.

📄️ Delete Case Attachment

The DELETE_ATTACHMENT event is triggered whenever a attachment delete.

📄️ Calendar Event Created

The CALENDAREVENTCREATED event is triggered whenever new calendar event is added in the case.

📄️ Calendar Event Rescheduled

The CALENDAREVENTRESCHEDULED event is triggered whenever new calendar event is rescheduled for case.

📄️ Calendar Event Status Update

The CALENDAREVENTSTATUS_UPDATED event is triggered whenever new calendar event is status update.

📄️ Calendar Event Canceled

The CALENDAREVENTCANCELED event is triggered whenever new calendar event cancel.

📄️ Add Case Decision

The ADDCASEDECISION event is triggered whenever new decision added in the case.

📄️ Decision Deleted

The DECISION_DELETED event is triggered whenever new decision delete from case.

📄️ Order Created

The ORDER_CREATED event is triggered whenever new order created.

📄️ Order Status Changed

The ORDERSTATUSCHANGED event is triggered whenever the order status is changed.

📄️ Order Tracking Added

The ORDERTRACKINGADDED event is triggered whenever the order tracking is added.

📄️ Add Payment Info Using Link

The ADDPAYMENTINFOUSINGLINK event is triggered patient added their payment info via payment setup link.

📄️ Payment Added

The PAYMENT_ADDED event is triggered when a payment is added to a case.

📄️ Payment Completed

The PAYMENT_COMPLETED event is triggered when a payment is completed for a case.

📄️ Payment Deleted

The PAYMENT_DELETED event is triggered when a payment is deleted from a case.

📄️ Payment Updated

The PAYMENT_UPDATED event is triggered when a payment is updated in a case.

📄️ Archive Case

The ARCHIVE_CASE event is triggered whenever case ha been mark close.

📄️ Reopen Case

The REOPEN_CASE event is triggered whenever case has been reopen after the close.

📄️ Add Form Response

The ADDFORMRESPONSE event is triggered whenever new form response added in the case.

📄️ Visit Type Changed

The VISITTYPECHANGED event is triggered whenever the visit type on a case is changed.

📄️ Add Case Product

The ADDCASEPRODUCT event is triggered whenever new case product add to the case.

📄️ Close Case Product

The CLOSECASEPRODUCT event is triggered whenever a case product is closed.

📄️ Open Case Product

The OPENCASEPRODUCT event is triggered whenever the existing case product is marked as open.

📄️ Send Check In

The SENDCHECKIN event is triggered when a check-in form is supposed to be sent to a patient. This is sent exclusively for organizations that handle check in themselves and have the organization setting enabled.

📄️ Check In Overdue

The CHECKINOVERDUE event is triggered on the following day when a patient has not completed their check-in form and the last SENDCHECKIN notification has already been sent.

📄️ Add Case Escalation

The ADDCASEESCALATION event is triggered whenever a new escalation is added to a case, whether the escalation was added by internal staff through the CareGLP application or by an external client through the REST API.

📄️ Update User

The UPDATE_USER event is triggered whenever a user's basic information is updated. It is sent to every organization that has an active case for that user, and the payload always contains the latest user information.

📄️ Update Case Escalation

The UPDATECASEESCALATION event is triggered when an existing escalation's note, assignedToId, or dueDate is edited, or the escalation is marked complete. At present, this is only possible through the CareGLP application; see the limitation below for how the REST API differs.

📄️ Remove Case Escalation

The REMOVECASEESCALATION event is triggered automatically; there is no direct action a user or client can take to fire it. It occurs when a patient, the case submitter on a partner organization's case, replies to a case through an in-app comment or an inbound email while an escalation with reason "waiting for patient reply" is still open in the support or clinical category. That escalation is completed as a result.

📄️ Escalate Case

The ESCALATE_CASE event is triggered whenever a case's isEscalated flag changes from false to true. This is a separate concept from the escalation records described in Add Case Escalation, Update Case Escalation, and Remove Case Escalation, and the two should not be confused: isEscalated is a single boolean on the case itself, not a record with a category, reason, or assignee.

📄️ Deescalate Case

The DEESCALATE_CASE event is triggered whenever a case's isEscalated flag is explicitly toggled from true to false. This is a separate concept from the escalation records described in Add Case Escalation, Update Case Escalation, and Remove Case Escalation, and the two should not be confused: isEscalated is a single boolean on the case itself, not a record with a category, reason, or assignee.