API Reference

Notify Endpoint

Send a push notification to any device that has the Clickfyre Ping app installed. No account, no OAuth, just a key and an HTTP request.

GET POST
https://api.ping.clickfyre.com/notify
Parameters

Request parameters

For GET requests pass parameters as query string values. For POST requests send a JSON object in the request body with Content-Type: application/json.

Parameter Required Max length Notes
key Required Your UUID device key, shown in the app
title Required 100 chars Notification title
body Optional 500 chars Notification body text
icon_url Optional 255 chars Must be an https:// URL
tags Optional 100 chars Comma-separated labels, e.g. sales,revenue
Examples

Request examples

Both methods produce identical results. Use whichever fits your environment.

GET query string 
curl 'https://api.ping.clickfyre.com/notify?key=YOUR_KEY&title=New+sale!&body=$49+from+John+Doe'
POST JSON body 
curl -X POST https://api.ping.clickfyre.com/notify \
  -H "Content-Type: application/json" \
  -d '{
    "key":   "YOUR_KEY",
    "title": "New sale!",
    "body":  "$49 from John Doe"
  }'
Responses

Success response

A 200 OK response confirms the notification was queued for delivery.

200 OK 
{
  "success": true,
  "quota": {
    "used":      1,
    "limit":     500,
    "remaining": 499
  }
}

Error responses

All error responses return a JSON body with an error field describing the problem.

Status Reason
400 Missing required parameter (key or title)
403 Key exists but is inactive
404 Key not found
429 Daily quota exceeded, resets at midnight UTC
Rate limits

Quota

Each key is allowed 500 notifications per day, resetting at midnight UTC. The current quota is returned in every successful response under the quota field.

500 notifications per day is plenty for any side project, automation, or personal tool. If you hit the limit, check your integration; something may be sending duplicates.
Try it

Send from your browser

No code needed. Use the web form to send a test notification straight to your device.

Send a Ping