PingOne Platform APIs

Send Notification

You can use the notifications endpoint to send a test notification to a mobile application by including the query parameter sync=true.

{{apiPath}}/environments/{{envID}}/notifications?sync=true

Send Notifications data model

Property Type? Required? Mutable? Description

application.id

Sting

Required

Immutable

The ID of the mobile application associated with the push message.

body

String

Required

Immutable

The text for the body of the push message.

createdAt

Date

N/A

Read-only

The time the resource was created.

data.type

String

Required

Immutable

Must be set to DRY for the test to work correctly.

deliveryMethod

String

Required

Immutable

The messaging service to be used. Should be one of the following values: GOOGLE, HUAWEI, IOS.

environment.id

String

N/A

Read-only

The ID of the relevant PingOne environment.

id

String

N/A

Read-only

The ID of the resource created.

policy.id

String

N/A

Read-only

The ID of the notification policy.

pushToken

String

Required

Immutable

The push token for the relevant application on the device.

status

String

N/A

Read-only

The result of the test push. If the push succeeded, value will be SENT. If there was a problem, a standard error response will be returned, containing details of the cause.

title

String

Required

Immutable

The title for the push message.

updatedAt

Date

N/A

Read-only

The time the resource was last updated.

vendor

String

N/A

Read-only

The type of push credential used. Will be APNS (for Apple), FCM_HTTP_V1 (for Google), HMS (for Huawei), or FCM (used previously for Google, no longer supported).