Customer Data Reference

The Customer event monitors a patient's journey and profile management on the platform, from initial signup to profile updates. Its payload contains all the relevant information about the patient.

Customer Event Payload

The payload below is a representation of a Customer event trigger.

The payload is based on the customer.signup event, but it is relevant for all customer-based trigger events. See the Workflow Events/Triggers article for a full list of available events.

{
    "organization": "your_org",
    "uname": "janedoe@email.com#your_org",
    "email": "janedoe@email.com",
    "phone": "+15551234567",
    "firstName": "Jan",
    "lastName": "Doe",
    "hash": "",
    "salt": "",
    "gender": "male",
    "dob": "1961-01-13",
    "addresses": [],
    "defaultAddress": {
        "province": "NY",
        "provinceCode": "NY",
        "address1": "123 Main Street",
        "address2": "Apt 4B",
        "city": "New York",
        "countryCode": "US",
        "postalCode": "10001"
    },
    "referrer": "",
    "identifiers": [],
    "notificationsCount": 0,
    "watchlist": [],
    "usedCoupons": [],
    "source": "signup",
    "assignedQuestionnaires": [],
    "providers": [],
    "groups": [],
    "isInsuranceAvailable": false,
    "acceptMarketing": true,
    "goals": [],
    "isOnboarded": false,
    "_id": "693723c57db04aefb2d7a9ea",
    "createdAt": "2025-12-08T19:15:17.701Z",
    "updatedAt": "2025-12-08T19:15:17.701Z",
    "__v": 0
}

Customer Object Properties

The table below describes the parameters of the payload.

Property	Type	Description
_id	string	A unique identifier for the patient (e.g., `693723c57db04aefb2d7a9ea`).
organization	string	The organization or brand associated with the patient.
uname	string	A unique username identifier. A combination of the patient’s email and your organization.
email	string	The patient's email address used for login and communication.
phone	string	The patient's contact phone number.
firstName	string	The patient's first name.
lastName	string	The patient's last name.
gender	string	The gender identity selected by the patient (e.g., "male").
dob	string	The patient's date of birth (YYYY-MM-DD).
addresses	array	A list of additional addresses associated with the patient.
defaultAddress	object	An object containing the primary address details.
defaultAddress.address1	string	The first line of the address.
defaultAddress.address2	string	The second line of the address (e.g., apartment number).
defaultAddress.city	string	The city name.
defaultAddress.province	string	The full name or abbreviation of the state/province (e.g., "NY").
defaultAddress.provinceCode	string	The state or province code (e.g., "NY").
defaultAddress.postalCode	string	The postal or ZIP code.
defaultAddress.countryCode	string	The country code (e.g., "US").
referrer	string	The source or individual who referred the patient, if any.
identifiers	array	A list of alternative unique identifiers for the patient.
notificationsCount	number	The count of unread notifications for the patient.
watchlist	array	Internal admin users who are currently watching this specific patient.
usedCoupons	array	A history of coupons redeemed by the patient.
source	string	The origin of the account creation (e.g., "signup").
assignedQuestionnaires	array	A list of medical questionnaires assigned to the patient.
providers	array	A list of healthcare providers assigned to the patient.
groups	array	A list of groups (e.g., providers) the patient belongs to.
isInsuranceAvailable	boolean	Indicates if insurance information is available.
acceptMarketing	boolean	Indicates if the patient consented to marketing communications.
goals	array	A list of health or treatment goals set for the patient. (See note below for usage details)
isOnboarded	boolean	Indicates if the patient has completed the full onboarding process. (See note below for usage details)
createdAt	string	The timestamp when the account was created.
updatedAt	string	The timestamp when the account was last updated.
__v	number	The document version number.

Note that the goals and isOnboarded fields are currently specific to weight loss programs. Organizations that choose to use these fields outside of that context are responsible for setting, maintaining, and managing the associated data.