Workflow Events/Trigger

A Trigger is the specific event that starts a workflow. An event is any activity within the CarePortals platform, such as an order's status changing or a customer's signup. When that specific event occurs, the workflow is automatically activated.

The platform offers a wide variety of events to choose from, grouped by category:

Order Events
Subscription Events
Appointment Events
Customer Events
Lead Events
Task Events
Form Events
Questionnaire Events
Communication Events
Prescription & Requisition Events
Cart Events
Webhook Events

Order Events

Monitors the progress of a customer's order, from creation and payment to fulfillment and shipping.

Event	Description
`order.created`	A new order has been created.
`order.subscription_cycle`	A new order has been created due to a subscription cycle.
`order.awaiting_payment`	The order's status has changed to Awaiting Payment. This is in the case of payment failure.
`order.processing`	It is a transactional status. Indicates that an order has been successfully created and the patient's payment has been processed.
`order.awaiting_requirements`	The order’s status has changed to Awaiting Requirements, indicating that it does not currently meet all necessary criteria. For example, the patient may not have completed a required questionnaire for the order.
`order.awaiting_requisition`	The order's status has changed to Awaiting Requisition. This status indicates that the order requires a lab test to be completed by the patient.
`order.awaiting_script`	The order’s status has changed to Awaiting Script, indicating it is waiting for a doctor’s prescription so the drugs can be sent to the pharmacy.
`order.awaiting_fulfillment`	A prescription or medication order has been received by the pharmacy but has not yet been prepared, so: The prescription has been submitted. The system has logged the order. It is in queue to be processed by the pharmacy staff (pharmacists or technicians). It’s not yet ready for pickup, delivery, or mailing. Technically, the prescription has been received but not connected with the order yet.
`order.awaiting_shipment`	The order's status has changed to Awaiting Shipment.
`order.shipping_address_updated`	The shipping address for an order has been changed.
`order.shipped`	The order's status has changed to Shipped.
`order.cancelled`	The order's status has changed to Cancelled.
`order.status_updated`	The order's status has been updated to any value.

Subscription Events

Manages changes in a customer's subscription status, including activation, pauses, cancellations, and renewals.

Event	Description
`subscription.created`	A new subscription has been created for a patient.
`subscription.active`	The subscription's status has changed to Active.
`subscription.paused`	The subscription's status has changed to Paused.
`subscription.cancelled`	The subscription's status has changed to Cancelled.
`subscription.ended`	The subscription's status has changed to Ended.
`subscription.upcoming-renewal`	A subscription is scheduled to renew soon. By default, the reminder is sent 7 days before the renewal date.

Appointment Events

Tracks the entire lifecycle of a patient's appointment, from its initial booking to its final status.

Event	Description
`appointment.create`	A new appointment has been booked.
`appointment.confirmed`	The appointment's status has changed to Confirmed.
`appointment.completed`	The appointment's status has changed to Completed.
`appointment.cancelled`	The appointment's status has changed to Cancelled.
`appointment.no-show`	The appointment has been marked as a No-Show.
`appointment.updated`	The details of an existing appointment has been changed.

Customer Events

Pertains to a user's journey and profile management on the platform, from initial signup to profile modifications. In the CarePortals platform, the term Customer corresponds to a Patient.

Event	Description
`customer.signup`	A new user has signed up on the platform from the patient portal.
`customer.created`	A new customer account was created manually by the Admin.
`customer.qnr-assigned`	A questionnaire has been assigned to a customer.
`customer.updated`	The customer’s profile information has been modified.

Lead Events

Follows the journey of a potential customer, from their initial capture as a lead to their conversion or loss.

Event	Description
`lead.created`	A new lead has been captured in the CRM portal.
`lead.converted`	A lead’s status has changed to Converted, and a customer record is now created for that lead.
`lead.lost`	A lead's status has changed to Lost.

Task Events

Relates to the management and status changes of internal tasks, such as their creation, completion, or cancellation.

Event	Description
`task.created`	A new task has been created.
`task.completed`	The task's status has changed to Completed.
`task.cancelled`	The task's status has changed to Cancelled.

Form Events

Event	Description
`form.submitted`	A patient or lead has submitted a standalone form, typically through our booking app. This is not related to medical questionnaires, but rather to web forms used during the lead or booking flow.

Questionnaire Events

Covers all interactions related to data submission and review through forms and questionnaires.

Event	Description
`questionnaire.started`	A patient has started a new questionnaire.
`questionnaire.submitted`	A patient has submitted their responses to a questionnaire.
`questionnaire.reviewed`	A staff member has reviewed a submitted questionnaire.

Communication Events

Logs incoming messages and communications received from external sources.

Event	Description
`message.inbound`	A new message has been received from a patient.

Prescription & Requisition Events

Tracks the status and lifecycle of medical requisitions and prescriptions from creation to final disposition.

Event	Description
`requisition.created`	A new lab requisition has been created.
`prescription.created`	A new prescription has been issued.
`prescription.fulfillment`	A prescription has been successfully linked to an order.
`prescription.voided`	A prescription has been voided.

Cart Events

Signifies key transactional moments in an online purchasing process.

Event	Description
`cart.checkout`	A patient has started the checkout process on their cart.

Webhook Events

Triggers notifications for interactions and data exchanges with external third-party systems.

Event	Description
`webhook.event`	A custom webhook event has been received.

Now that you understand what an event is, you may want to explore the following pages.

How to Use Adapters: Connect your workflow to external services and perform specific actions.
How to Use the CRM Actions: Configure your workflow to automatically send messages, update CRM records, and more.
How to Use the Wait Component: Add delays to control when actions happen within a workflow.
How to Use Conditions: Create logic paths by setting rules that split your workflow’s behavior.
Trigger Events Payloads Index: See the payload for each trigger event type.