Salesforce Mobile Notifications Implementation Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Mobile Notifications Overview
Steps for Implementing Mobile Notifications
Sending Mobile Notifications
Using Apex Triggers to Send Push Notifications
Custom Notification Actions
Using the Connect REST API Push Notification Resource (Optional)
Reference
PDF

Custom Notification Actions

Send custom notifications to recipients via desktop or mobile channels.

Before you send a custom notification, you must first create a notification type.

In orgs created in Winter ’21 or later, the Send Custom Notifications user permission is required to trigger the Send Custom Notification action in flows that run in user context, REST API calls, and Apex callouts.

The Send Custom Notifications user permission isn’t required to trigger the Send Custom Notification action in processes or flows that run in system context.

Important

This object is available in API version 46.0 and later.

Supported REST HTTP Methods

URI
/services/data/vXX.X/actions/standard/customNotificationAction
Formats
JSON, XML
HTTP Methods
GET, HEAD, POST
Authentication
Authorization: Bearer token

Inputs

Input Details
customNotifTypeId
Type
reference
Description
Required. The ID of the Custom Notification Type being used for the notification.
recipientIds
Type
reference
Description
Required. The ID of the recipient or recipient type of the notification. Valid recipient or recipient type values are:
  • UserId — The notification is sent to this user, if this user is active.
  • AccountId — The notification is sent to all active users who are members of this account’s Account Team.

    This recipient type is valid if account teams are enabled for your org.

  • OpportunityId — The notification is sent to all active users who are members of this opportunity’s Opportunity Team.

    This recipient type is valid if team selling is enabled for your org.

  • GroupId — The notification is sent to all active users who are members of this group.
  • QueueId — The notification is sent to all active users who are members of this queue.
Values can be combined in a list up to the maximum of 500 values.
senderId
Type
reference
Description
Optional. The User ID of the sender of the notification.
title
Type
string
Description
Required. The title of the notification, as seen by recipients. Maximum characters: 250.

The content of mobile push notifications depends on the content push notification setting.
body
Type
string
Description
Required. The body of the notification, as seen by recipients. Maximum characters: 750.

The content of mobile push notifications depends on the content push notification setting..
targetId
Type
reference
Description
Optional. The Record ID for the target record of the notification.

You must specify either a targetID or a targetPageRef.
targetPageRef
Type
string
Description
Optional. The PageReference for the navigation target of the notification.

To see how to specify the target using JSON, see pageReference.

You must specify either a targetID or a targetPageRef.

Usage

GET

The following example shows how to get information about the custom notification action type:
curl --include --request GET \
--header "Authorization: Authorization: Bearer 00DR...xyz" \
--header "Content-Type: application/json" \
"https://instance.salesforce.com/services/data/v46.0/actions/standard/customNotificationAction"

POST

The following example shows how to create a custom notification action:
curl --include --request POST \
--header "Authorization: Authorization: Bearer 00DR...xyz" \
--header "Content-Type: application/json" \
--data '{ "inputs" :
  [
  {
    "customNotifTypeId" : "0MLR0000000008eOAA",
    "recipientIds" : ["005R0000000LSqtIAG"],
    "title" : "Custom Notification",
    "body" : "This is a custom notification.",
    "targetId" : "001R0000003fSUDIA2"
  }
  ]
}' \
"https://instance.salesforce.com/services/data/v46.0/actions/standard/customNotificationAction"
The response is:
[
   {
      "actionName" : "customNotificationAction",
      "errors" : null,
      "isSuccess" : true,
      "outputValues" : {
         "SuccessMessage" : "Your custom notification is processed successfully."
      }
   }
]