This document provides a comprehensive guide to our Push Notification API, which allows developers to integrate push notification functionality into their applications.

Overview

Push notifications are a powerful way to engage with users and keep them informed about important updates or events. Our API makes it easy to send push notifications to your users' devices.

Features

  • Real-time Notifications: Send notifications instantly to your users' devices.
  • Segmentation: Target specific user segments based on criteria such as location, device type, or user behavior.
  • Customization: Personalize your notifications with rich content, including images, links, and actions.

Getting Started

Before you start using the Push Notification API, make sure you have the following:

  • A valid API key
  • A list of user devices to which you want to send notifications

API Key

To obtain an API key, please visit our API Key Management.

API Endpoints

The following are the available endpoints for the Push Notification API:

  • /sendNotification: Send a push notification to one or more devices.
  • /listDevices: List all devices associated with your account.
  • /deleteDevice: Delete a device from your account.

Usage Example

Here's an example of how to send a push notification using the /sendNotification endpoint:

POST /sendNotification
Content-Type: application/json

{
  "api_key": "YOUR_API_KEY",
  "devices": [
    "device_token_1",
    "device_token_2"
  ],
  "title": "New Message",
  "body": "You have a new message from Jane.",
  "data": {
    "action": "open_app",
    "url": "/messages"
  }
}

Troubleshooting

If you encounter any issues while using the Push Notification API, please refer to our Troubleshooting Guide.

Resources

For more information, please visit the following resources:

Push Notification Example