Push Notifications Resource
Send a mobile push notification to connected apps on users’
devices. This resource is only accessible when the session is established with a connected
app that is developed in the same organization or installed in the same package as the
recipient’s connected app.
- Resource
-
/connect/notifications/push
- Available version
- 31.0
- HTTP methods
- POST
- Request body for POST
-
- Root XML tag
- <pushNotification>
- JSON example
-
{ "appName" : "TestApp", "namespace" : "abc", "userIds" : ["005x00000013dPK", "005x00000013dPL"], "payload" : "{'aps':{'alert':'test', 'badge':0, 'sound':'default'}}" }
- Properties
-
- Request parameters for POST
-
Parameter Name Type Description Required or Optional Available Version appName String The API name of the connected app that the push notification is sent to. Required 31.0 namespace String The namespace of the connected app that the push notification is sent to. Required if the namespace is set 31.0 payload String The push notification payload in JSON format. Required 31.0 userIds String[] The push notification recipient user ids. Required 31.0