REST API

Push notification API that just works

Send push notifications and start iOS live activities with a simple REST API. Bearer token auth, JSON payloads, and predictable responses. Integrate in minutes.

What is the Chirpme API?

A straightforward REST API that lets you send push notifications and control iOS live activities from any language, framework, or automation tool. Authenticate with a Bearer token and send JSON.

Bearer token auth

Generate API keys from the dashboard. Include the key as a Bearer token in the Authorization header.

JSON in, JSON out

Send and receive standard JSON. Works with curl, fetch, Axios, or any HTTP client.

Fast delivery

Notifications are dispatched within seconds. Live activities update in real time.

How it works

Two endpoints cover the most common workflows: sending a push notification and starting a live activity.

Send a push notification

curl -X POST https://chirpme.app/api/v1/notifications \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "channelCode": "my-channel",
    "title": "New order received",
    "body": "Order #1234 from Jane Doe - $89.00",
    "url": "https://example.com/orders/1234"
  }'

Start a live activity

curl -X POST https://chirpme.app/api/v1/live-activities \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "channelCode": "my-channel",
    "template": "progress",
    "fields": {
      "title": "Uploading files",
      "progress": 0.45,
      "status": "Processing batch 3 of 7"
    }
  }'

Response format

{
  "success": true,
  "data": {
    "id": "ntf_abc123",
    "channelCode": "my-channel",
    "title": "New order received",
    "recipientCount": 42,
    "createdAt": "2026-03-22T10:30:00Z"
  }
}

API keys & rate limits

Key management

  • Create and revoke keys from the dashboard
  • Name keys for easy identification (e.g. “Production”, “Staging”)
  • Keys are shown once on creation -- store them securely
  • Revoke compromised keys instantly

Rate limits

Free
250 notifications / month
Starter
2,500 notifications / month
Pro
10,000 notifications / month
Business
50,000+ notifications / month

Use cases

The API fits into any workflow that can make an HTTP request.

CI/CD pipelines

Send a notification when a deploy succeeds or fails. One curl command in your pipeline script.

Monitoring & alerting

Trigger push notifications from Datadog, PagerDuty, or custom health checks via webhook.

E-commerce backends

Notify customers about order status, shipping updates, and promotions from your server code.

IoT & home automation

Push alerts from Raspberry Pi, Home Assistant, or any device that can call an HTTP endpoint.

Get your API key in 30 seconds

Sign up, create a channel, and generate an API key. Start sending notifications with a single curl command.