Browse the API reference
API reference
Base URL: https://nowlark.com. Send it an API key and a notification, it reaches every device on the account.
Quickstart#
Your key#
Install the app, then Settings › Connect an App › Create Your Key, and copy it: it is shown once.
The first request#
curl https://nowlark.com/v1/notify \
-H "X-Nowlark-Key: nlk_…" \
-H "Content-Type: application/json" \
-d '{"source":"Backup","title":"Finished","priority":1}'
Your phone lights up, usually within seconds.
The response#
{
"id": "ntf_5f3c…",
"duplicate": false,
"muted": false,
"delivered": 2,
"devices": 2,
"remaining": 997,
"reset_at": 1789665600.0
}
delivered / devices: how many of the account's registered devices Apple accepted it for.
delivered: 0 with devices: 0 means no phone has registered yet, not a failure.
Every other page covers one part of that request. A script only ever needs an API key.
Every page#
Getting started
Authentication and rate limitThe two kinds of key, how to send one, checking a key for free, and the hourly limit.ExamplesThe same send from curl, from Python, and from the nowlark command for shell scripts.Sending
Send a notificationThe one request that sends: every field, its limit, and the response.Priority and repeatThe five levels, what each does on the phone, and alerts that repeat until opened.Links, images and buttonsA link to open, links inside the text, a picture or screenshot, and the four buttons.SourcesNaming each sender, and listing a source before it sends.Scheduled sendsSend after a delay, at a set time, or on a repeating schedule.Webhook templatesPoint GitHub, Alertmanager, Grafana, Datadog, Sentry, Uptime Kuma or Healthchecks.io straight at Nowlark, no code to write.Receipts and replies
Receipts and callbacksWhat became of a notification, and the URL called when it is read.RepliesAsk a question the person answers with one tap.Teams
Teams, roles and endpointsRoles, invites, members and every team endpoint.Channels and escalationChannel keys, threads, ack policy, escalation, heartbeats, grouping and maintenance windows.Webhooks and emailSigned webhooks and verified email for a channel.Alert email and timelineEmail for the alerts you miss, on your own rules, and who was told about an alert and when.Team formsWebsite forms that arrive as alerts on a channel.Plans, audit log and transferHow a plan is judged, who changed what, and handing a team over.Company sign‑in and SCIMOpenID Connect sign‑in and automatic provisioning.The web consoleManage a team from a browser, signed in with a passkey.Account
Identity and moving phonesUsed by the iOS app: the account, its keys, devices and history.Devices, keys and historyRegister devices, manage keys, read history, tune sources.The Upgrade PassHow the iOS app reads and redeems Upgrade Pass purchases. None of it affects sending.Compatibility
ntfy's publish APIPoint an ntfy notifier at Nowlark by changing its server address, and keep the rest of its setup.Prowl's APIProwl's own endpoints, and moving a script across call by call.Appendix
Endpoint indexEach method and path, linked to its section.Errors and status codesThe error shape and the HTTP status codes.LimitsRate limits, field lengths, counts and windows.Priorities and fieldsPriority levels and every send, response and receipt field.GlossaryShort definitions of the terms used across the API reference.Step-by-step guides#
