{ "event_data": "(Optional) Data associated with the event, *not* automatically stored on the Morf Profile", "event_id": "(Optional) Unique identifier for the event (e.g. a UUID)", "event_name": "(Required) Event name", "occurred_at": "(Optional) Time the event occurred, if not provided - the time Morf receives the track event (RFC3339 ISO Format)", "profile_ids": { "active_campaign": "(Optional) An Active Campaign Contact ID", "athena": "(Optional) An Athena Patient ID", "axle_health": "(Optional) An Axle Health Patient ID", "butterfly_labs": "(Optional) A Butterfly Labs Patient ID", "customer": "(Optional) Any unique identifier in your organization", "customer_io": "(Optional) A Customer.io Customer ID", "elation": "(Optional) An Elation Patient ID", "feathery": "(Optional) A user ID for a Feathery flow", "formsort": "(Optional) A responder UUID for a Formsort flow", "freshdesk": "(Optional) A Freshdesk Contact ID", "healthie": "(Optional) A Healthie User (Patient) ID", "hubspot": "(Optional) A Hubspot Contact ID", "intakeq": "(Optional) An IntakeQ Patient ID", "intercom": "(Optional) An Intercom Contact ID", "junction": "(Optional) A Junction Patient ID", "open_phone": "(Optional) An OpenPhone Contact ID", "recurly": "(Optional) A Recurly Subscriber ID", "sana_benefits": "(Optional) A Sana Benefits Patient ID", "segment": "(Optional) A Segment Anonymous- or User- ID", "stripe": "(Optional) A Stripe Customer ID" }, "profile_properties": "(Optional) Property values to store on the Morf Profile", "source_id": null, "user_id": "(Required) Unique user ID. Note: this value will be stored as the active customer ID"}
The Morf Track API is used to send structured event and profile data to Morf. These events are used to trigger workflows which automatically update profile properties for your customers (Morf Profiles).
An example payload and description of the payload fields is given on the right hand side.
Any event_name is supported as an event type. For example, join-button-clicked is a valid event name. There are no limitations on the character set or length of the event name, however we recommend using a short, descriptive name which is easy to understand and identify.
Submit a POST request to the Morf Track API endpoint (ask your customer success liaison for details of the endpoint to use or navigate to the Connect tab of a Track workflow’s trigger node in the graph).
The POST request should include a JSON body with the data defined in the schema below. See the example and a description of the payload on the right hand side for details. We recommend setting the Content-Type: application/json header if you wish.
If a field is marked (Optional), you can either send that field in the payload or not. Eliding the key is tolerated as is submitting null as the value. These are treated equivalently.
Profile properties are used to store data on a Morf Profile. Any field matching an existing Morf Profile Property type will be updated on the Morf Profile. For example, if the payload’s profile properties object contains a date_of_birth field, the Morf Profile’s date_of_birth property will be updated.
New scalar field values inside this object will be added to the Morf Profile as new properties. For example, if you sent a new field like favorite_color with a value of blue, the new Property type will be created and updated on the Morf Profile.
Event data is used to store data associated with the event. This data is not automatically stored on the Morf Profile but is available to be accessed within a Morf Workflow.
This object is used to store IDs from third party systems. The customer field is used to store a unique identifier in your organization. The other fields are used to store IDs from other third party systems.
{ "event_data": "(Optional) Data associated with the event, *not* automatically stored on the Morf Profile", "event_id": "(Optional) Unique identifier for the event (e.g. a UUID)", "event_name": "(Required) Event name", "occurred_at": "(Optional) Time the event occurred, if not provided - the time Morf receives the track event (RFC3339 ISO Format)", "profile_ids": { "active_campaign": "(Optional) An Active Campaign Contact ID", "athena": "(Optional) An Athena Patient ID", "axle_health": "(Optional) An Axle Health Patient ID", "butterfly_labs": "(Optional) A Butterfly Labs Patient ID", "customer": "(Optional) Any unique identifier in your organization", "customer_io": "(Optional) A Customer.io Customer ID", "elation": "(Optional) An Elation Patient ID", "feathery": "(Optional) A user ID for a Feathery flow", "formsort": "(Optional) A responder UUID for a Formsort flow", "freshdesk": "(Optional) A Freshdesk Contact ID", "healthie": "(Optional) A Healthie User (Patient) ID", "hubspot": "(Optional) A Hubspot Contact ID", "intakeq": "(Optional) An IntakeQ Patient ID", "intercom": "(Optional) An Intercom Contact ID", "junction": "(Optional) A Junction Patient ID", "open_phone": "(Optional) An OpenPhone Contact ID", "recurly": "(Optional) A Recurly Subscriber ID", "sana_benefits": "(Optional) A Sana Benefits Patient ID", "segment": "(Optional) A Segment Anonymous- or User- ID", "stripe": "(Optional) A Stripe Customer ID" }, "profile_properties": "(Optional) Property values to store on the Morf Profile", "source_id": null, "user_id": "(Required) Unique user ID. Note: this value will be stored as the active customer ID"}
{ "event_data": "(Optional) Data associated with the event, *not* automatically stored on the Morf Profile", "event_id": "(Optional) Unique identifier for the event (e.g. a UUID)", "event_name": "(Required) Event name", "occurred_at": "(Optional) Time the event occurred, if not provided - the time Morf receives the track event (RFC3339 ISO Format)", "profile_ids": { "active_campaign": "(Optional) An Active Campaign Contact ID", "athena": "(Optional) An Athena Patient ID", "axle_health": "(Optional) An Axle Health Patient ID", "butterfly_labs": "(Optional) A Butterfly Labs Patient ID", "customer": "(Optional) Any unique identifier in your organization", "customer_io": "(Optional) A Customer.io Customer ID", "elation": "(Optional) An Elation Patient ID", "feathery": "(Optional) A user ID for a Feathery flow", "formsort": "(Optional) A responder UUID for a Formsort flow", "freshdesk": "(Optional) A Freshdesk Contact ID", "healthie": "(Optional) A Healthie User (Patient) ID", "hubspot": "(Optional) A Hubspot Contact ID", "intakeq": "(Optional) An IntakeQ Patient ID", "intercom": "(Optional) An Intercom Contact ID", "junction": "(Optional) A Junction Patient ID", "open_phone": "(Optional) An OpenPhone Contact ID", "recurly": "(Optional) A Recurly Subscriber ID", "sana_benefits": "(Optional) A Sana Benefits Patient ID", "segment": "(Optional) A Segment Anonymous- or User- ID", "stripe": "(Optional) A Stripe Customer ID" }, "profile_properties": "(Optional) Property values to store on the Morf Profile", "source_id": null, "user_id": "(Required) Unique user ID. Note: this value will be stored as the active customer ID"}
Assistant
Responses are generated using AI and may contain mistakes.
