Actions Developer Guide

Introducing Actions
Action Objects
Apex Actions
Assign Enablement Program
Apply Case Classification Recommendations
B2B and D2C Commerce Actions
Cancel Approval Submission Action
Commerce Checkout Flow Actions
Convert Base64 Speech to Text Action
Create Service Document Actions
Create Service Report Actions
Custom Notification Actions
Deploy Data Kit Components Action
Email Alert Actions
Einstein Bots Actions
Exit Individuals from a Flow Action
Explore Conversation Actions
Flow Actions
Generate Order Summary Action
Generate Work Orders Actions
Get Assessment Response Summary
Get Conversation Intelligence Action
Get Conversation Transcript Action
Get Data Graph Data By Lookup
Get Data Graph Metadata
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
Reassign Approval Work Item Action
Recall Approval Submission Action
Refresh Metric Actions
Review Approval Work Item Action
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
Speech to Text Action
Submit Exchange Order
Submit for Approval Actions
Survey Invitation Actions
Text to Speech Action (Beta)
Work Plan and Work Step Actions
PDF

Flow Actions

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

For more information about creating flows, see Build a Flow in Salesforce Help.

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

Supported REST HTTP Methods

URIs:

  • 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 will include Flow__InterviewStatus and any output variables defined in the flow. For more information, see Flow Resource: Variable in Salesforce Help.

Output Type Description
Flow__InterviewStatus picklist The status of the flow interview: Created, Started, Finished, Error, or Waiting.

Legacy Support for Process Builder

Processes created with type 'Invocable' in Process Builder can also be invoked via REST, using the endpoint listed above. 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.