Custom Invocable Actions

Returns the list of all custom actions. You can also get basic information for each type of action.

This resource is available in REST API version 32.0 and later.

Syntax

URI

Get a list of custom actions:

/vXX.X/actions/custom

Formats

JSON, XML

HTTP Methods

GET, HEAD, POST

Authentication

Authorization: Bearer token

Parameters

None

Notes

Sending email with the emailAlert action counts against your daily email limit for workflows. For more information, see “Daily Limits for Email Alerts” in the Salesforce Help.

When invoking an Apex action using the POST method and supplying the inputs in the request, only the following primitive types are supported as inputs:

Blob
Boolean
Date
Datetime
Decimal
Double
ID
Integer
Long
String
Time

Describe and invoke for an Apex action respect the profile access for the Apex class. If you don’t have access an error is issued.

If you add an Apex action to a flow, and then remove the Invocable Method annotation from the Apex class, a runtime error in the flow occurs.

When a flow user invokes an autolaunched flow, the active flow version is run. If there’s no active version, the latest version is run. When a flow admin invokes an autolaunched flow, the latest version is always run.

If any of the following elements are used in a flow, packageable components that reference these elements aren’t automatically included in the package.

Apex
Email alerts
Post to Chatter
Quick Actions
Send Email
Submit for Approval

For example, if you use an email alert, manually add the email template that is used by that email alert. To deploy the package successfully, manually add those referenced components to the package.

Example

Retrieving a list of custom actions for the current organization:

1/services/data/v33.0/actions/custom

JSON Response body

1{
2  "quickAction" : "/services/data/v33.0/actions/custom/quickAction",
3  "apex" : "/services/data/v33.0/actions/custom/apex",
4  "emailAlert" : "/services/data/v33.0/actions/custom/emailAlert",
5  "flow" : "/services/data/v33.0/actions/custom/flow"
6}

Force.com REST API Developer Guide

Custom Invocable Actions

Syntax