Flow Actions

Invoke an active autolaunched flow or active invocable process that exists in the current org.

For more information about creating flows and processes, see Build a Flow and Create a Process in the Salesforce Help.

This object is available for autolaunched flows in API version 32.0 and later. This object is available for invocable processes in API version 38.0 and later.

Supported REST HTTP Methods

URI: Get a list of available flow actions:; /vXX.X/actions/custom/flow; Invokes the LargeOrder flow:; /vXX.X/actions/custom/flow/LargeOrder
Formats: JSON, XML
HTTP Methods: GET, HEAD, POST
Authentication: Authorization: Bearer token

Inputs

Input values vary according to the input variables specified for each flow. For autolaunched flows, the input values vary according to the input variables in that flow.

Invocable processes always require either one of the following input parameters:

sObjectId: The Id of the sObject record that you want the process to execute on. The record must be of the same object type as the one on which the process is defined.
sObject: The sObject itself that you want the process to execute on. The sObject must be of the same object type as the one on which the process is defined.

Outputs

Output values vary according to the output variables specified. Flow__InterviewStatus is available for flows. Invocable processes do not have outputs.

Output	Details
Flow__InterviewStatus	Type picklist Description The current status of the flow interview. Valid values are: Created Started Finished Error Waiting

Actions Developer Guide

Flow Actions

Supported REST HTTP Methods

Inputs

Outputs