A convenience endpoint to deliver a push notification payload to a single device or set of devices identified by their client identifier.
643 matches
19 actions
Platform
19 actions
- Enumerate all active channels of the applicationGETv1.0.0
- Get a device registrationGETv1.0.0
- Get message history for a channelGETv1.0.0
- Get metadata of a channelGETv1.0.0
- Get presence history of a channelGETv1.0.0
- Get presence of a channelGETv1.0.0
- Get the service timeGETv1.0.0
- List all channels with at least one subscribed deviceGETv1.0.0
- List channel subscriptionsGETv1.0.0
- List devices registered for receiving push notificationsGETv1.0.0
- Publish a message to a channelPOSTv1.0.0
- Publish a push notification to device(s)POSTv1.0.0
- Register a device for receiving push notificationsPOSTv1.0.0
- Retrieve usage statistics for an applicationGETv1.0.0
- Subscribe a device to a channelPOSTv1.0.0
- Unregister a single device for push notificationsDELETEv1.0.0
- Unregister matching devices for push notificationsDELETEv1.0.0
- Update a device registrationPATCHv1.0.0
- Update a device registrationPUTv1.0.0
Infrastructure/Platform
Publish a push notification to device(s)
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
{
"type": "object",
"required": [
"recipient"
],
"properties": {
"push": {
"type": "object",
"properties": {
"apns": {
"type": "object",
"description": "Extends and overrides generic values when delivering via APNs. [See examples](https://www.ably.io/documentation/general/push/publish#payload-structure)",
"properties": {
"notification": {
"type": "object",
"properties": {
"body": {
"type": "string",
"description": "Text below title on the expanded notification."
},
"collapseKey": {
"type": "string",
"description": "Platform-specific, used to group notifications together."
},
"icon": {
"type": "string",
"description": "Platform-specific icon for the notification."
},
"sound": {
"type": "string",
"description": "Platform-specific sound for the notification."
},
"title": {
"type": "string",
"description": "Title to display at the notification."
}
}
}
}
},
"data": {
"type": "string",
"description": "Arbitrary [key-value string-to-string payload](https://www.ably.io/documentation/general/push/publish#channel-broadcast-example)."
},
"fcm": {
"type": "object",
"description": "Extends and overrides generic values when delivering via GCM/FCM. [See examples](https://www.ably.io/documentation/general/push/publish#payload-structure)",
"properties": {
"notification": {
"type": "object",
"properties": {
"body": {
"type": "string",
"description": "Text below title on the expanded notification."
},
"collapseKey": {
"type": "string",
"description": "Platform-specific, used to group notifications together."
},
"icon": {
"type": "string",
"description": "Platform-specific icon for the notification."
},
"sound": {
"type": "string",
"description": "Platform-specific sound for the notification."
},
"title": {
"type": "string",
"description": "Title to display at the notification."
}
}
}
}
},
"notification": {
"type": "object",
"properties": {
"body": {
"type": "string",
"description": "Text below title on the expanded notification."
},
"collapseKey": {
"type": "string",
"description": "Platform-specific, used to group notifications together."
},
"icon": {
"type": "string",
"description": "Platform-specific icon for the notification."
},
"sound": {
"type": "string",
"description": "Platform-specific sound for the notification."
},
"title": {
"type": "string",
"description": "Title to display at the notification."
}
}
},
"web": {
"type": "object",
"description": "Extends and overrides generic values when delivering via web. [See examples](https://www.ably.io/documentation/general/push/publish#payload-structure)",
"properties": {
"notification": {
"type": "object",
"properties": {
"body": {
"type": "string",
"description": "Text below title on the expanded notification."
},
"collapseKey": {
"type": "string",
"description": "Platform-specific, used to group notifications together."
},
"icon": {
"type": "string",
"description": "Platform-specific icon for the notification."
},
"sound": {
"type": "string",
"description": "Platform-specific sound for the notification."
},
"title": {
"type": "string",
"description": "Title to display at the notification."
}
}
}
}
}
}
},
"recipient": {
"type": "object",
"description": "Push recipient details for a device.",
"properties": {
"clientId": {
"type": "string",
"description": "Client ID of recipient"
},
"deviceId": {
"type": "string",
"description": "Client ID of recipient"
},
"deviceToken": {
"type": "string",
"description": "when using APNs, specifies the required device token."
},
"registrationToken": {
"type": "string",
"description": "when using GCM or FCM, specifies the required registration token."
},
"transportType": {
"type": "string",
"description": "Defines which push platform is being used.",
"enum": [
"apns",
"fcm",
"gcm"
]
}
}
}
}
}Output
- 1
- 2
- 3
- 4
{
"type": "object",
"additionalProperties": true
}