POST /push/publish
A convenience endpoint to deliver a push notification payload to a single device or set of devices identified by their client identifier.
Servers
- https://rest.ably.io
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
X-Ably-Version |
String | No |
The version of the API you wish to use. |
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
format |
String | No |
The response format you would like Possible values:
|
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
push |
Object | No | |
push.data |
String | No |
Arbitrary key-value string-to-string payload. |
push.apns |
Object | No |
Extends and overrides generic values when delivering via APNs. See examples |
push.apns.notification |
Object | No | |
push.apns.notification.collapseKey |
String | No |
Platform-specific, used to group notifications together. |
push.apns.notification.body |
String | No |
Text below title on the expanded notification. |
push.apns.notification.title |
String | No |
Title to display at the notification. |
push.apns.notification.sound |
String | No |
Platform-specific sound for the notification. |
push.apns.notification.icon |
String | No |
Platform-specific icon for the notification. |
push.fcm |
Object | No |
Extends and overrides generic values when delivering via GCM/FCM. See examples |
push.fcm.notification |
Object | No | |
push.fcm.notification.collapseKey |
String | No |
Platform-specific, used to group notifications together. |
push.fcm.notification.body |
String | No |
Text below title on the expanded notification. |
push.fcm.notification.title |
String | No |
Title to display at the notification. |
push.fcm.notification.sound |
String | No |
Platform-specific sound for the notification. |
push.fcm.notification.icon |
String | No |
Platform-specific icon for the notification. |
push.web |
Object | No |
Extends and overrides generic values when delivering via web. See examples |
push.web.notification |
Object | No | |
push.web.notification.collapseKey |
String | No |
Platform-specific, used to group notifications together. |
push.web.notification.body |
String | No |
Text below title on the expanded notification. |
push.web.notification.title |
String | No |
Title to display at the notification. |
push.web.notification.sound |
String | No |
Platform-specific sound for the notification. |
push.web.notification.icon |
String | No |
Platform-specific icon for the notification. |
push.notification |
Object | No | |
push.notification.collapseKey |
String | No |
Platform-specific, used to group notifications together. |
push.notification.body |
String | No |
Text below title on the expanded notification. |
push.notification.title |
String | No |
Title to display at the notification. |
push.notification.sound |
String | No |
Platform-specific sound for the notification. |
push.notification.icon |
String | No |
Platform-specific icon for the notification. |
recipient |
Object | Yes |
Push recipient details for a device. |
recipient.transportType |
String | No |
Defines which push platform is being used. Possible values:
|
recipient.deviceToken |
String | No |
when using APNs, specifies the required device token. |
recipient.registrationToken |
String | No |
when using GCM or FCM, specifies the required registration token. |
recipient.deviceId |
String | No |
Client ID of recipient |
recipient.clientId |
String | No |
Client ID of recipient |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.