Push Notifications API

Use the Push Notifications API to send push notifications to users’ devices running native iOS and Android App Catalogs. You can send three types of push notifications:

  • Application Message: An application message push notification goes to devices which have downloaded the specified app.
  • Application Update Notification: When you upload a new version of an application, an application update notification goes to devices onto which users have downloaded the previous version of the application.
  • Group Message: A group message push notification goes to devices of all members of the specified group.

Note

Push notifications are supported with native App Catalogs only. Users running an HTML5 App Catalog will not receive push notifications from EASE.

Resources

POST /v1/notifications/applications/(app_psk)/message

Send Application Message

Requires administrator privileges. Authenticate as an EASE administrator.

Sends an application message push notification to devices onto which an App Catalog user has downloaded the application.

This triggers a user notification on the device that, when tapped by the user, displays the name of the application and the message.

URLs

Environment URL
North America https://na01ws.apperian.com/v1/notifications/applications/<int:app_psk>/message
Europe https://eu01ws.apperian.eu/v1/notifications/applications/<int:app_psk>/message

URL Parameters

app_psk
(Required) Unique ID assigned by EASE to the application. DATA TYPE: integer

Header Parameter

X-TOKEN
(Required) Session token returned by POST /users/authenticate.
Content-Type
(Required) Specifies the content type of the body of data sent with the request. Set to: application/json

Data Parameters

message
(Required) UTF-8-compatible message string. Maximum characters: 150

Example Request

curl -X POST https://na01ws.apperian.com/v1/notifications/applications/23/message --header "Content-Type: application/json" --header "X-Token: eTg8ktZXRqKIBJTHanwP6A" --data '{"message": "Please log in to your App Catalog to install the latest version of the Sales Tracker app."}'

Example Response

{
     "app_message_notification_sent": True
}
POST /v1/notifications/applications/(app_psk)/update

Send Application Update Notification

Requires administrator privileges. Authenticate as an EASE administrator.

Sends an application update push notification to devices onto which App Catalog users have downloaded a previous version of the application.

This triggers a notification on the device that, when tapped by the user, opens the App Catalog. From the App Catalog, the user can install the update.

URLs

Environment URL
North America https://na01ws.apperian.com/v1/notifications/applications/<int:app_psk>/update
Europe https://eu01ws.apperian.eu/v1/notifications/applications/<int:app_psk>/update

URL Parameters

app_psk
(Required) Unique ID assigned by EASE to the application. DATA TYPE: integer

Header Parameter

X-TOKEN
(Required) Session token returned by POST /users/authenticate.
Content-Type
(Include only if sending a data parameter) Specifies the content type of the body of data sent with the request. Set to: application/json

Data Parameters

mandatory
(Optional) Set to true if the update is mandatory. Set to false if the update is not mandatory. When an update is mandatory, the user is prompted to install it when he/she logs in to the App Catalog. A user cannot continue to use the App Catalog until all mandatory updates are installed.

Example Request

curl -X POST https://na01ws.apperian.com/v1/notifications/applications/68/update --header "Content-Type: application/json" --header "X-Token: eTg8ktZXRqKIBJTHanwP6A" --data '{"mandatory":true}'

Note: If you are not sending the optional mandatory parameter, do not include the “Content-Type” header. For example:

curl -X POST https://na01ws.apperian.com/v1/notifications/applications/68/update --header "X-Token: eTg8ktZXRqKIBJTHanwP6A"

Example Response

{
     "update_notification_sent": True
}
POST /v1/notifications/groups/(int: group_psk)/message

Send Group Message

Requires administrator privileges. Authenticate as an EASE administrator.

Sends a group message push notification to devices owned by users belonging to a specific group. This triggers a user notification on the device that, when tapped by the user, displays the name of the group and the message.

URLs

Environment URL
North America https://na01ws.apperian.com/notifications/v1/applications/<int:group_psk>/message
Europe https://eu01ws.apperian.eu/notifications/v1/applications/<int:group_psk>/message

URL Parameters

group_psk
(Required) Unique ID assigned by EASE to the group whose members you want to send the message. This ID is returned by the GET /groups/ resource. DATA TYPE: integer

Header Parameter

X-TOKEN
(Required) Session token returned by POST /users/authenticate.
Content-Type
(Required) Specifies the content type of the body of data sent with the request. Set to: application/json

Data Parameters

message
(Required) UTF-8-compatible message string. Maximum characters: 150

Example Request

curl -X POST https://na01ws.apperian.com/notifications/groups/23/message --header "Content-Type: application/json" --header "X-Token: eTg8ktZXRqKIBJTHanwP6A" --data '{"message": "Please log in to the App Catalog to install the Sales Tracker app."}'

Example Response

{
     "group_message_notification_sent": True
}