Push
API reference

GET /notify/{apiKey}

Send a notification from a webhook using query parameters.

Replace the apiKey path parameter with your account or team API key. Pass title and body as query parameters; URL-encode their values. No x-api-key header is needed.

Treat the resulting URL as a secret. Prefer the header-authenticated endpoint when your integration supports it.

GET/notify/{apiKey}

Path Parameters

apiKey*string

Account / Team API Key

Query Parameters

title*string

Notification title

body*string

Notification Body

sound?string

Notification sound, valid options are default, arcade, correct, fail, harp, reveal, bubble, doorbell, flute, money, scifi, clear, elevator, guitar, pop.

channel?string

Notification channel, alphanumerical string and hyphens only.

link?string

Notification link URL (URL Encoded)

image?string

Notification image URL (URL Encoded)

timeSensitive?boolean

Time sensitive notifications will be delivered immediately, even if the device is in do not disturb mode. (iOS only)

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/notify/string?title=string&body=string"
{  "success": true,  "message": "string",  "responses": [    {      "success": true,      "message": "string"    }  ]}

POST /notify

Send a notification to all devices in your account or team.

POST /notify/{apiKey}

Send a notification from a webhook using a JSON request body.