Pushinator API Reference

Pushinator API uses API keys to authenticate requests. You can view and manage your API keys in Pushinator Console. Do not share your secret API key in publicly accessible areas such as GitHub, client-side code, and so on.

Each request must include a bearer Authorization header with the API token in it, otherwise, the request will be rejected with a 401 Unauthorized response.

Authorization: Bearer YOUR_API_TOKEN

The API will respond with conventional HTTP response codes to indicate the outcome of your requests.

• 2xx codes indicate success. The request was received, understood, and accepted.
• 4xx codes indicate an error in the information you provided, e.g a required field is not included.
• 5xx codes mean that something is wrong on our side. Retry and let us now if the issue persists.

In addition to that, every response you get from our API contains a message property that provides a human-readable explanation of the response.

To send a notification, make a POST request to the api/v2/notifications/send endpoint. The body of the request must be a JSON object with the following properties:

{
  "channel_id": "YOUR-CHANNEL-UUID",
  "content": "Your message here"
}

The response will be a JSON object with the following properties:

{
  "success": true,
  "message": "Notification created and being sent to subscribers"
}

For a language-specific approach, check out our guides on how to send notifications using our client libraries with PHP and Rust.

Here's an example of how to send a notification using cURL:

curl "https://api.pushinator.com/api/v2/notifications/send" \
  -X "POST" \
  -H "Authorization: Bearer YOUR-API-KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "channel_id": "YOUR-CHANNEL-UUID",
    "content": "Test notification content"
  }'