API reference menu
Getting started
OverviewAuthentication and rate limitExamplesSending
Send a notificationPriority and repeatLinks, images and buttonsSourcesScheduled sendsWebhook templatesReceipts and replies
Receipts and callbacksRepliesTeams
Teams, roles and endpointsChannels and escalationWebhooks and emailAlert email and timelineTeam formsPlans, audit log and transferCompany sign‑in and SCIMThe web consoleAccount
Identity and moving phonesDevices, keys and historyThe Upgrade PassCompatibility
ntfy's publish APIProwl's APIAppendix
Endpoint indexErrors and status codesLimitsPriorities and fieldsGlossaryExamples
curl:
curl -sS https://nowlark.com/v1/notify \
-H "X-Nowlark-Key: $NOWLARK_API_KEY" \
-H 'Content-Type: application/json' \
-d '{"source":"Backup","title":"Nightly backup finished","body":"482 GB in 41 min","priority":-1}'
Python: nowlark.py uses the standard library only, so there is nothing to install. Fetch it with
curl -O https://nowlark.com/clients/nowlark.py:
from nowlark import notify
notify("CI", "Build 4181 failed", "Tests passed, signing did not.",
url="https://ci.yourcompany.com/builds/4181", priority=1, dedupe="build-4181")
Shell, for anything that is not Python, nowlark:
nowlark "Backup" "Nightly backup finished" "482 GB in 41 min" --priority -1