Documentation

Send Push Notifications


Send push notifications to devices by hitting up our REST API from your backend.

Backend Code Samples


We provide implementations in the following languages to help you send push notifications from your backend:

Implementation


Interface with our Send Notifications API by sending a POST request as follows:

https://api.pushy.me/push?api_key=SECRET_API_KEY

Make sure to replace SECRET_API_KEY with your app's Secret API Key listed in the Dashboard.

Note: This is a backend API endpoint. Never expose your application's Secret API Key in your client code.

Sample Request Body

Send the following sample request body along with your request:

{
    "to": "a6345d0278adc55d3474f5",
    "data": {
        "message": "Hello World!"
    },
    "notification": {
        "body": "Hello World \u270c",
        "badge": 1,
        "sound": "ping.aiff"
    }
}

Make sure to replace a6345d0278adc55d3474f5 with a device token or a topic (i.e. /topics/news). Also, replace the contents of the data object with any payload data you want to make available to your app's notification listener / receiver.

Note: The notification object within the sample request body is used to customize the built-in iOS notification and does not affect Android devices.

Check out the complete Send Notifications API reference for more information about this API.

Backend Setup Complete


Now that you've finished both the client and backend implementation, try to send your app a test push notification from your backend to verify that everything works.

We thank you for choosing Pushy. Let us know if you have any ideas on how to improve our service.