You are here:
On-Demand Flows
Trigger on-demand flows by using external REST API calls. For example, create an automation to send an SMS message after a user signs up for a membership or clicks a button on your site.
Required Editions
| Available in: Lightning Experience |
| This feature is available in Enterprise and Unlimited Editions with Marketing Cloud Growth or Advanced Edition. |
| Available in: All Editions supported by Data 360. See Data 360 edition availability. |
On-Demand Flows integrate high-scale marketing flows into external systems via API calls. Marketing admins maintain control of flow logic and messaging while developers handle the integration. This approach makes it possible for you to create personalized customer experiences that respond to real-time events from your external systems.
Usage
Before triggering your flow, grant access to the triggering user. Learn more in Give Users Access to Trigger On-Demand Flows
To trigger the flow, use a REST call with the standard Salesforce invocable action endpoint for the flow. For example, to trigger a flow named FLOW_API_NAME, use a POST call.
POST /services/data/v65.0/actions/custom/flow/FLOW_API_NAMEBefore triggering the flow, you can use a REST call to get the flow description and its available inputs. For example, to get the flow description and inputs for a flow named FLOW_API_NAME, use a GET call.
GET /services/data/v65.0/actions/custom/flow/FLOW_API_NAMEInputs
Input values vary according to the input variables specified in the flow. EmailAddress, IndividualId, and TelephoneNumber are always available as input.
| Input | Description | Required? |
|---|---|---|
| EmailAddress | The contact email address for the individual. | No |
| IndividualId | The ID for the individual Data Model Object. | Yes |
| TelephoneNumber | The contact phone number for the individual. | No |
| ProcessingPriority | The priority to give the bulk request. | No |
Each custom variable that you include in the POST request must have a corresponding variable in the flow with Available for input selected. Otherwise, the flow doesn't recognize the value as an input. If the flow doesn't use the data, don't include it in the POST request, and remove the variable from the flow.
