Skip to content
Nowlark
Sign inGet the app
How it worksPricingDocsTeams
Get the appSign in
API reference menu

Getting started

OverviewAuthentication and rate limitExamples

Sending

Send a notificationPriority and repeatLinks, images and buttonsSourcesScheduled sendsWebhook templates

Receipts and replies

Receipts and callbacksReplies

Teams

Teams, roles and endpointsChannels and escalationWebhooks and emailAlert email and timelineTeam formsPlans, audit log and transferCompany sign‑in and SCIMThe web console

Account

Identity and moving phonesDevices, keys and historyThe Upgrade Pass

Compatibility

ntfy's publish APIProwl's API

Appendix

Endpoint indexErrors and status codesLimitsPriorities and fieldsGlossary

Endpoint index

Each method and path in the reference, linked to the section that documents it.

Authentication and rate limit#

MethodPath and where it is documented
GET
/v1/key/checkIn Authentication and rate limit: GET /v1/key/check

Send a notification#

MethodPath and where it is documented
POST
/v1/notifyIn Send a notification: POST /v1/notify
MethodPath and where it is documented
POST
/v1/imagesIn Links, images and buttons: Images

Sources#

MethodPath and where it is documented
POST
/v1/sourcesIn Sources: POST /v1/sources

Scheduled sends#

MethodPath and where it is documented
GET
/v1/scheduledIn Scheduled sends: Scheduled sends
DELETE
/v1/scheduled/{id}In Scheduled sends: Scheduled sends

Webhook templates#

MethodPath and where it is documented
POST
/v1/hooks/{template}In Webhook templates

Receipts and callbacks#

MethodPath and where it is documented
GET
/v1/receipts/{id}In Receipts and callbacks

Replies#

MethodPath and where it is documented
POST
/v1/notifications/{id}/replyIn Replies

Teams, roles and endpoints#

MethodPath and where it is documented
GET
/v1/channels/{id}In Teams, roles and endpoints
PATCH
/v1/channels/{id}In Teams, roles and endpoints
DELETE
/v1/channels/{id}In Teams, roles and endpoints
POST
/v1/channels/{id}/destinations/{destination_id}/enableIn Teams, roles and endpoints
POST
/v1/channels/{id}/destinations/{destination_id}/resendIn Teams, roles and endpoints
POST
/v1/channels/{id}/destinations/{destination_id}/testIn Teams, roles and endpoints
GET
/v1/channels/{id}/keysIn Teams, roles and endpoints
POST
/v1/channels/{id}/keysIn Teams, roles and endpoints
DELETE
/v1/channels/{id}/keys/{key_id}In Teams, roles and endpoints
PUT
/v1/channels/{id}/members/{member_id}In Teams, roles and endpoints
DELETE
/v1/channels/{id}/members/{member_id}In Teams, roles and endpoints
GET
/v1/teamsIn Teams, roles and endpoints
POST
/v1/teamsIn Teams, roles and endpoints
POST
/v1/teams/joinIn Teams, roles and endpoints
GET
/v1/teams/{id}In Teams, roles and endpoints
DELETE
/v1/teams/{id}In Teams, roles and endpoints
GET
/v1/teams/{id}/channelsIn Teams, roles and endpoints
POST
/v1/teams/{id}/channelsIn Teams, roles and endpoints
GET
/v1/teams/{id}/forms/{slug}/attachments/{id}In Teams, roles and endpoints
GET
/v1/teams/{id}/forms/{slug}/exportIn Teams, roles and endpoints
GET
/v1/teams/{id}/forms/{slug}/submissionsIn Teams, roles and endpoints
PATCH
/v1/teams/{id}/forms/{slug}/submissions/{id}In Teams, roles and endpoints
DELETE
/v1/teams/{id}/forms/{slug}/submissions/{id}In Teams, roles and endpoints
POST
/v1/teams/{id}/forms/{slug}/submissions/{id}/claimIn Teams, roles and endpoints
GET
/v1/teams/{id}/forms/{slug}/submissions/{submission_id}In Teams, roles and endpoints
GET
/v1/teams/{id}/invitesIn Teams, roles and endpoints
POST
/v1/teams/{id}/invitesIn Teams, roles and endpoints
DELETE
/v1/teams/{id}/invites/{invite_id}In Teams, roles and endpoints
PATCH
/v1/teams/{id}/meIn Teams, roles and endpoints
DELETE
/v1/teams/{id}/members/meIn Teams, roles and endpoints
PATCH
/v1/teams/{id}/members/{member_id}In Teams, roles and endpoints
DELETE
/v1/teams/{id}/members/{member_id}In Teams, roles and endpoints

Channels and escalation#

MethodPath and where it is documented
GET
/v1/channels/{id}/escalationIn Channels and escalation: Escalation
PUT
/v1/channels/{id}/escalationIn Channels and escalation: Escalation
DELETE
/v1/channels/{id}/escalationIn Channels and escalation: Escalation

Webhooks and email#

MethodPath and where it is documented
GET
/v1/channels/{id}/destinationsIn Webhooks and email
POST
/v1/channels/{id}/destinationsIn Webhooks and email
DELETE
/v1/channels/{id}/destinations/{destination_id}In Webhooks and email

Alert email and timeline#

MethodPath and where it is documented
PUT
/v1/channels/{id}/me/emailIn Alert email and timeline: Email for the alerts you miss
GET
/v1/channels/{id}/threadsIn Alert email and timeline: The timeline of an alert
GET
/v1/me/notificationsIn Alert email and timeline: Email for the alerts you miss
POST
/v1/me/notifications/contactsIn Alert email and timeline: Email for the alerts you miss
POST
/v1/me/notifications/contacts/{contact_id}/resendIn Alert email and timeline: Email for the alerts you miss
DELETE
/v1/me/notifications/contacts/{id}In Alert email and timeline: Email for the alerts you miss
PUT
/v1/me/notifications/quietIn Alert email and timeline: Email for the alerts you miss
PUT
/v1/me/notifications/rulesIn Alert email and timeline: Email for the alerts you miss
POST
/v1/me/notifications/testIn Alert email and timeline: Email for the alerts you miss
GET
/v1/teams/{id}/notificationsIn Alert email and timeline: Email for the alerts you miss
PUT
/v1/teams/{id}/notificationsIn Alert email and timeline: Email for the alerts you miss

Team forms#

MethodPath and where it is documented
GET
/f/templates/{name}In Team forms
GET
/f/{slug}In Team forms: Its own page, one line of script, and its look
GET
/org/team/{id}/forms/{slug}In Team forms
POST
/v1/forms/{slug}In Team forms
GET
/v1/forms/{slug}/embed.jsIn Team forms: Its own page, one line of script, and its look
GET
/v1/forms/{slug}/fill.jsIn Team forms
GET
/v1/forms/{slug}/form.cssIn Team forms: Its own page, one line of script, and its look
POST
/v1/teams/{id}/channels/{channel_id}/dry-runIn Team forms: Business hours
GET
/v1/teams/{id}/connectionsIn Team forms: Post to Slack, Microsoft Teams, Discord or a webhook
POST
/v1/teams/{id}/connectionsIn Team forms: Post to Slack, Microsoft Teams, Discord or a webhook
DELETE
/v1/teams/{id}/connections/{connection_id}In Team forms: Post to Slack, Microsoft Teams, Discord or a webhook
POST
/v1/teams/{id}/connections/{connection_id}/enableIn Team forms: Post to Slack, Microsoft Teams, Discord or a webhook
POST
/v1/teams/{id}/connections/{connection_id}/testIn Team forms: Post to Slack, Microsoft Teams, Discord or a webhook
GET
/v1/teams/{id}/formsIn Team forms
POST
/v1/teams/{id}/formsIn Team forms
PATCH
/v1/teams/{id}/forms/{slug}In Team forms
DELETE
/v1/teams/{id}/forms/{slug}In Team forms
GET
/v1/teams/{id}/forms/{slug}/googleIn Team forms: Google Analytics and Tag Manager
GET
/v1/teams/{id}/forms/{slug}/google/container.jsonIn Team forms: Google Analytics and Tag Manager
POST
/v1/teams/{id}/forms/{slug}/google/testIn Team forms: Google Analytics and Tag Manager
POST
/v1/teams/{id}/forms/{slug}/look/previewIn Team forms: Its own page, one line of script, and its look
POST
/v1/teams/{id}/forms/{slug}/submissions/{submission_id}/dry-runIn Team forms: Business hours
GET
/v1/teams/{id}/forms/{slug}/testIn Team forms: Two versions of a form
POST
/v1/teams/{id}/forms/{slug}/testIn Team forms: Two versions of a form
PATCH
/v1/teams/{id}/forms/{slug}/test/bIn Team forms: Two versions of a form
POST
/v1/teams/{id}/forms/{slug}/test/b/look/previewIn Team forms: Two versions of a form
POST
/v1/teams/{id}/forms/{slug}/test/keepIn Team forms: Two versions of a form
GET
/v1/teams/{id}/hoursIn Team forms: Business hours
PUT
/v1/teams/{id}/hoursIn Team forms: Business hours
DELETE
/v1/teams/{id}/hoursIn Team forms: Business hours
GET
/v1/teams/{id}/rulesIn Team forms: Routing rules
POST
/v1/teams/{id}/rulesIn Team forms: Routing rules
PUT
/v1/teams/{id}/rules/orderIn Team forms: Routing rules
POST
/v1/teams/{id}/rules/schedule/dry-runIn Team forms: A digest on a schedule
PATCH
/v1/teams/{id}/rules/{rule_id}In Team forms: Business hours
DELETE
/v1/teams/{id}/rules/{rule_id}In Team forms: Business hours
POST
/v1/teams/{team_id}/forms/{slug}/fields/previewIn Team forms: Your own fields

Plans, audit log and transfer#

MethodPath and where it is documented
GET
/v1/teams/{id}/auditIn Plans, audit log and transfer: Audit log
GET
/v1/teams/{id}/planIn Plans, audit log and transfer: Plans and billing
POST
/v1/teams/{id}/plan/checkoutIn Plans, audit log and transfer: Plans and billing
POST
/v1/teams/{id}/plan/trialIn Plans, audit log and transfer: Plans and billing
GET
/v1/teams/{id}/transferIn Plans, audit log and transfer: Ownership transfer
POST
/v1/teams/{id}/transferIn Plans, audit log and transfer: Ownership transfer
DELETE
/v1/teams/{id}/transferIn Plans, audit log and transfer: Ownership transfer
POST
/v1/teams/{id}/transfer/acceptIn Plans, audit log and transfer: Ownership transfer
POST
/v1/teams/{id}/transfer/declineIn Plans, audit log and transfer: Ownership transfer

Company sign‑in and SCIM#

MethodPath and where it is documented
GET
/scim/v2/GroupsIn Company sign‑in and SCIM: Automatic provisioning (SCIM 2.0)
GET
/scim/v2/ResourceTypesIn Company sign‑in and SCIM: Automatic provisioning (SCIM 2.0)
GET
/scim/v2/SchemasIn Company sign‑in and SCIM: Automatic provisioning (SCIM 2.0)
GET
/scim/v2/ServiceProviderConfigIn Company sign‑in and SCIM: Automatic provisioning (SCIM 2.0)
GET
/scim/v2/UsersIn Company sign‑in and SCIM: Automatic provisioning (SCIM 2.0)
POST
/scim/v2/UsersIn Company sign‑in and SCIM: Automatic provisioning (SCIM 2.0)
GET
/scim/v2/Users/{id}In Company sign‑in and SCIM: Automatic provisioning (SCIM 2.0)
PUT
/scim/v2/Users/{id}In Company sign‑in and SCIM: Automatic provisioning (SCIM 2.0)
PATCH
/scim/v2/Users/{id}In Company sign‑in and SCIM: Automatic provisioning (SCIM 2.0)
DELETE
/scim/v2/Users/{id}In Company sign‑in and SCIM: Automatic provisioning (SCIM 2.0)
POST
/v1/sso/discoverIn Company sign‑in and SCIM: Company sign‑in (Okta and other OpenID Connect providers)
POST
/v1/sso/handoffIn Company sign‑in and SCIM: Company sign‑in (Okta and other OpenID Connect providers)
GET
/v1/teams/{id}/domainsIn Company sign‑in and SCIM: Email domains
POST
/v1/teams/{id}/domainsIn Company sign‑in and SCIM: Email domains
DELETE
/v1/teams/{id}/domains/{domain}In Company sign‑in and SCIM: Email domains
POST
/v1/teams/{id}/domains/{domain}/verifyIn Company sign‑in and SCIM: Email domains
GET
/v1/teams/{id}/scimIn Company sign‑in and SCIM: Automatic provisioning (SCIM 2.0)
DELETE
/v1/teams/{id}/scimIn Company sign‑in and SCIM: Automatic provisioning (SCIM 2.0)
POST
/v1/teams/{id}/scim/tokenIn Company sign‑in and SCIM: Automatic provisioning (SCIM 2.0)
GET
/v1/teams/{id}/ssoIn Company sign‑in and SCIM: Company sign‑in (Okta and other OpenID Connect providers)
PUT
/v1/teams/{id}/ssoIn Company sign‑in and SCIM: Company sign‑in (Okta and other OpenID Connect providers)
DELETE
/v1/teams/{id}/ssoIn Company sign‑in and SCIM: Company sign‑in (Okta and other OpenID Connect providers)
PUT
/v1/teams/{id}/sso/requiredIn Company sign‑in and SCIM: Company sign‑in (Okta and other OpenID Connect providers)
POST
/v1/teams/{id}/sso/testIn Company sign‑in and SCIM: Company sign‑in (Okta and other OpenID Connect providers)

The web console#

MethodPath and where it is documented
GET
/orgIn The web console
GET
/org/api/sessionIn The web console
GET
/org/loginIn The web console
GET
/org/passkeysIn The web console
POST
/v1/web/pairingsIn The web console

Identity and moving phones#

MethodPath and where it is documented
GET
/v1/accessIn Identity and moving phones: Identity
DELETE
/v1/access/{id}In Identity and moving phones: Identity
POST
/v1/enrollIn Identity and moving phones: Identity
GET
/v1/meIn Identity and moving phones: Identity
PATCH
/v1/meIn Identity and moving phones: Identity
DELETE
/v1/meIn Identity and moving phones: Identity
PUT
/v1/me/historyIn Identity and moving phones: Identity
PUT
/v1/me/repeatIn Identity and moving phones: Identity
POST
/v1/me/rotate-keyIn Identity and moving phones: Identity
PUT
/v1/me/soundsIn Identity and moving phones: Identity
POST
/v1/transfer/claimIn Identity and moving phones: Moving to a phone on another Apple Account
POST
/v1/transfer/startIn Identity and moving phones: Moving to a phone on another Apple Account

Devices, keys and history#

MethodPath and where it is documented
GET
/healthIn Devices, keys and history
GET
/v1/devicesIn Devices, keys and history
POST
/v1/devicesIn Devices, keys and history
DELETE
/v1/devices/{id}In Devices, keys and history
GET
/v1/keysIn Devices, keys and history
POST
/v1/keysIn Devices, keys and history
PATCH
/v1/keys/{id}In Devices, keys and history
DELETE
/v1/keys/{id}In Devices, keys and history
POST
/v1/keys/{id}/rotateIn Devices, keys and history
GET
/v1/notificationsIn Devices, keys and history
POST
/v1/notifications/readIn Devices, keys and history
DELETE
/v1/notifications/{id}In Devices, keys and history
POST
/v1/notifications/{id}/ackIn Devices, keys and history
GET
/v1/sourcesIn Devices, keys and history
PATCH
/v1/sources/{id}In Devices, keys and history
DELETE
/v1/sources/{id}In Devices, keys and history

The Upgrade Pass#

MethodPath and where it is documented
GET
/v1/passIn The Upgrade Pass
POST
/v1/pass/notifyIn The Upgrade Pass
POST
/v1/pass/redeemIn The Upgrade Pass

ntfy's publish API#

MethodPath and where it is documented
POST
/In ntfy's publish API
POST
/<topic>In ntfy's publish API
PUT
/<topic>In ntfy's publish API
POST
/ntfyIn ntfy's publish API

Prowl's API#

MethodPath and where it is documented
GET
/publicapi/addIn Prowl's API: GET|POST /publicapi/add
POST
/publicapi/addIn Prowl's API: GET|POST /publicapi/add
GET
/publicapi/verifyIn Prowl's API: GET|POST /publicapi/verify
POST
/publicapi/verifyIn Prowl's API: GET|POST /publicapi/verify
PreviousProwl's APINextErrors and status codes