Newer Version Available

This content describes an older version of this product. View Latest

Flow Actions

Invoke a headless active flow that exists in the current organization.

For more information about creating flows, see Creating a Flow in the Salesforce online help.

This object is available in API version 32.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.

Outputs

Output values vary according to the output variables specified for each flow, but Flow__InterviewStatus is available for all flows.

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