Push Notifications

(ms.push_notifications)

Push notifications are the mobile alerts or message that pops up on a mobile device.



Fields

Value Description
title   
Type: string
Required
The title of the notification. This field is not visible on iOS phones and tablets.
message   
Type: string
Required
The text for the push notification.
image   
Type: string
The URL of the notification icon. It is visible only on Android.
summary   
Type: string
The text shown with the picture message instead of the entire message when the notification is not collapsed.
picture   
Type: string
The image URL of picture in the notification that you are sending to users.
url   
Type: string
The URL on which the user is redirected on clicking on the notification.
app_id   
Type: string
Required
The app on which the notifications are sent.
filters   
Type: object
It stores the users who get the notification.
type
Type: string
Required
The type of the filter.
uuid
Type: array
List of the UUID of the users to which the notifications would be sent.
user
Type: array
List of users to which the notifications would be sent.
group
Type: array
The selected user groups who will receive the notification.
role
Type: array
custom
Type: array
All the users who have installed the app and has currently installed the app who will receive the notification.

Commands (Endpoints)

POST /api/1/entity/ms.push_notifications   
Creates a new push notification
DEL /api/1/entity/ms.push_notifications/{resource_id}   
Deletes a push notification
PUT /api/1/entity/ms.push_notifications/{resource_id}   
Updates an existing push notification
GET /api/1/entity/ms.push_notifications/{resource_id}   
Retrieves a single push notification
GET /api/1/entity/ms.push_notifications   
Retrieves a list of push notifications