Send To Engage
The Send to Engage activity sends data from a workflow to Engage. Each call reports one event — an event you defined in the application manifest — along with the data you map to that event's schema.
When to use it
Place a Send to Engage activity at each point in a workflow that represents a milestone an operator needs to see: a batch starting, a message being sent, a record completing. The data you map here is what appears in Engage's columns and views.
Before you begin
- Define the event in the application manifest and publish the manifest. See Prepare an Application for Engage.
- Provision the application in Engage and map the event's schema to report columns, so the data has somewhere to land. See Map events to columns.
- Establish the Engage context earlier in the workflow with the Set Context activity. Send to Engage references that context rather than creating one.
Configuration
| Field | Required | Description | Example |
|---|---|---|---|
| Name | Required | Specify the name for this activity. | MyActivity |
| Description | Optional | Specify the description for this activity. | Report batch start to Engage |
| Select Engage Context | Optional | The Engage context to report through. This is the same context for every Send to Engage call in a workflow. | |
| Select Event | Optional | The manifest event this call reports. Selecting an event loads that event's schema so you can map workflow data to its fields. |
Selecting the event is what determines the shape of the input. Change the event and the mappable fields change with it.
Input
| Field | Required | Data Type | Description | Example |
|---|---|---|---|---|
| Status | Optional | String | The state to record for this event. | In Queue |
| Data | Optional | Object | The event data, mapped to the selected event's schema fields. |
Updating a record in place
Several Send to Engage activities may report the same event within one workflow execution. Later calls update the record the earlier one created rather than adding a new one, which is how a status progresses as work moves through the workflow.
A common shape:
- After the work is dispatched, report the event with Status set to a pending value.
- At the point the outcome is known, report the same event again with Status set to the final value.
Engage shows one record whose status has advanced, not two records.
How you know it worked
The event's fields appear populated in the Engage view built on that event's columns, for the matching execution. See Validate the data flow for what to check on the Engage side.
Common errors
| Symptom | Cause | What to do |
|---|---|---|
| No events available in Select Event | The application manifest is unpublished, or defines no events | Publish the manifest with at least one event defined |
| Data arrives in Engage but the columns are empty | The event's schema fields are not mapped, or are mapped to the wrong fields | Reselect the event to reload its schema, then check the mapping |
| Two records where one was expected | The two calls report different events | Use the same event in both calls to update in place |
Related activities
- Set Context — establishes the Engage context this activity references.
Select Engage Context and Select Event also appear on the Rest Client activity, where they are shown only when Send to Engage is checked.