Test Push Notifications
POST {{apiPath}}/environments/{{envID}}/notifications?sync=true
This example uses the notifications
endpoint with the query parameter sync=true
to test push notifications for a mobile application.
If the push was successfully received, the status
field in the response will be SENT
. If there was a problem, a standard error response will be returned, containing details of the cause.
You must set data.type
to DRY
for the test to work correctly.
The following query parameters are allowed in the request:
Parameter | Values |
---|---|
expand | attributes |
sync | true |
Property | Type | Required? |
---|---|---|
application.id | String | Required |
body | String | Required |
data.type | String | Required |
deliveryMethod | String | Required |
pushToken | String | Required |
title | String | Required |
See the Send Notifications data model for full property descriptions.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
expand | string | ||
sync | boolean |
Request Body
{"title"=>"PingOne test", "body"=>"Test push successful", "deliveryMethod"=>"Google", "pushToken"=>"{{pushToken}}", "application"=>{"id"=>"{{appID}}"}, "data"=>{"type"=>"DRY"}}