Actions Developer Guide

Introducing Actions
Action Objects
Apex Actions
Assign Enablement Program
Apply Case Classification Recommendations
B2B and D2C Commerce Actions
Commerce Checkout Flow Actions
Create Service Document Actions
Create Service Report Actions
Custom Notification Actions
Deploy Data Kit Components Action
Email Alert Actions
Einstein Bots Actions
Flow Actions
Generate Order Summary Action
Generate Work Orders Actions
Get Assessment Response Summary
Knowledge Actions
Lead Action
Live Message Notification Actions
Omni-Channel Action
Apply Payment Action
Payment Sale Action
Perform Survey Sentiment Analysis
PlatformAction
Post to Chatter Actions
Preview Cart to Exchange Order
Prompt Template Actions
Quick Actions
Refresh Metric Actions
Sales Engagement Actions
Salesforce Omnichannel Inventory Actions
Salesforce Order Management Actions
Send Conversation Messages Actions
Send Notification Actions
Session-Based Permission Set Actions
Simple Email Actions
Submit Exchange Order
Submit for Approval Actions
Survey Invitation Actions
Work Plan and Work Step Actions
PDF

Newer Version Available

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

Flow Actions

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

For more information about creating flows and processes, see Build a Flow.

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

Supported REST HTTP Methods

URI
Get a list of available flow actions:
/services/data/vXX.X/actions/custom/flow
Invokes the LargeOrder flow:
/services/data/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.

Outputs

The response to an invocation includes Flow__InterviewStatus and any output variables defined in the flow.

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

Legacy Support for Process Builder

Process Builder processes created with the Invocable process type can be invoked by REST API using the endpoint /services/data/vXX.X/actions/custom/flow. See Create a Process in Salesforce Help. This object is available for invocable processes in API version 38.0 and later.

Invocable processes always require one of these input parameters:

  • 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.
  • 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.

Invocable processes don’t have outputs.