RelayMessageAction

Label

The label of the action which is displayed within the main flow layout.

API Name

The unique API Name of this flow action.

Description

Optional description of this action.

Relay Client ID

This optional field is used to identify the Relay Client ID in a multi-client setup. The majority of configuration will not be a multi-client setup. See: Multiple Relay Clients in a Single Org

Send via Future

This value determines if the Relay Messaging Action should use a future when making the callout to Relay. Sending in a future is useful to prevent any slowdown in processing of the flow's primary logic.

• If this action is running in the asynchronous path of the flow, then it is already running in a future so the value should be left out or set to {!$GlobalConstant.False}.

• If no value is passed in, then the default value will be {!$GlobalConstant.False}.

Valid values are:

• {!$GlobalConstant.False} = Run the action in the current flow process.

• {!$GlobalConstant.True} = Run the action in a future.

Batch Request

Either this value or the Single Request value or both must be provided.

• An apex-defined variable of type RelayMessageRequest Resource which has the Allow multiple values (collection) option selected.

• Allows you to send multiple Relay messaging requests in a single callout. This is more performant and reduced the consumption against your daily API limits.

CAUTION

When submitting a batch, make sure all records in the batch are of the same type. For example, don’t mix account and contact objects in a single batch.

Single Request

Either this value or the Batch Request value or both must be provided.

• An apex-defined variable of type RelayMessageRequest Resource.

• Typically used for Record Triggered flows as you are usually dealing with only the single record.

Dynamic input_ variable names

Optional. A flow variable resource with Data Type of Text and the Allow multiple values (collection) option checked. The resource collection should have been previously populated with a list of fields names. These field names will be used by this action to retrieve their values.

The record, whose values will be retreived from, is identified by the id field provided in the Batch Request or Single Request resource.

See: Relay Dynamic Inputs

Trigger ID

Optional. Identifies the Relay message to be sent to the specified user(s). If no value is provided, then the Trigger ID must have been provided within the Batch Request or Single Request resource.

The Trigger ID is defined within the Relay CXB Web Application. See: Locating the Relay Trigger ID