Live Message Notification Actions

Use messaging templates to send notifications to users over communication channels, such as SMS, WhatsApp, and Facebook Messenger, when certain conditions are met.

This action is available in API version 43.0 and later.

For more information about using Live Message Notification actions in flows, see Create Flows to Send Automatic Message Notifications in Salesforce Help.

Special Access Rules

To access Live Message Notification action for Surveys, you must have the Feedback Management Starter or Growth license and Salesforce org enabled with a default community.

Supported REST HTTP Methods

URI: /services/data/v43.0/actions/standard/liveMessageNotification

Formats: JSON, XML

HTTP Methods: GET, HEAD, POST

Authentication: Authorization: Bearer token

Inputs

Input Type Description
channelDeveloperName string Required. The unique name of the messaging channel that's used to send the messaging notification.
contextRecordId ID The entity ID of the sObject that's used as the context for the merge field in a messaging template. To resolve a merge field, the contextRecordId input property is required.
conversationBroadcastId ID The entity ID of the sObject that links all the messages within a broadcast.
recipientPhone string The destination phone number that the message is sent to. If the messaging channel type is SMS and the recipientRecordId input property isn't a messaging user, then the recipientPhone input property is required.
recipientRecordId ID Required. The MessagingEndUserId property or the Record ID associated with a recipient phone number, to send the message notification.
surveyDeveloperName string The API name of the survey that's sent in the message. Available in API version 57.0 and later. This input property is applicable to Surveys only.
templateDeveloperName string Required. The unique name of the messaging template that's used to generate the message.
triggeredOutboundTypeEnum picklist The type of triggered outbound message: Standard or Broadcast.

Outputs

None.

Example

GET

The following example shows how to get information about the Live Message Notification action type:

1curl --include --request GET \
2--header "Authorization: Authorization: Bearer 00DR...xyz" \
3--header "Content-Type: application/json" \
4"https://instance.salesforce.com/services/data/v43.0/actions/standard/liveMessageNotification"

POST

Here's an example request for the Live Message Notification action:

1{
2   "inputs":[{
3      "templateDeveloperName":"MessageQ3Template",
4      "channelDeveloperName":"MessageQ3Template",
5      "contextRecordId":"003RO00000480RvYAM",
6      "recipientRecordId":"0PARM000000GJzo4AG"
7   }]
8}

Here's an example response for the Live Message Notification action:

1[
2   {
3      "actionName" : "liveMessageNotification",
4      "errors" : null,
5      "isSuccess" : true,
6      "outputValues" : null
7   }
8]