The following headers are necessary:
Authorization: with the value in the following format:
Content-Type: with the value always set to
A JSON object with the following keys:
interests(Array<string>|required): Array of interests to send the push notification to, ranging from 1 to 100 per publish request.
webhookUrl(String|optional): a URL to which we will send webhooks at key points throughout the publishing process. E.g when the publish finishes.
- At least one of:
apns: the payload to be sent to APNs. The full set of options for the APNs section of the
notifycall is described in Apple's Payload Key Reference. For further examples, see Apple's “Creating the Remote Notification Payload”.
fcm: the payload to be sent to FCM. The full set of options is described by Google in their documentation of FCM downstream HTTP messages.
Each interest name can be up to 164 characters. Each character in the name must be an ASCII upper- or lower-case letter, a number, or one of
A JSON object with the following fields:
publishId(string|required): Unique string used to identify this publish request.
|Invalid content type||400||Only |
|Incomplete Request||400||Authorization header is missing.|
|Bad request||400||Request body size is too large (max 10KiB).|
|Bad request||400||Failed to read body as a JSON object.|
|Unauthorized||401||Incorrect API Key.|
|Instance not found||404||Could not find the instance.|
|Unprocessable Entity||422||JSON does not our match schema.|
|Something went wrong||500||Internal server error.|