Skip to content
Nofy by Encipher Docs
Support Nofy home Sign in

API reference

API reference

Every client-facing endpoint, with typed parameters and request and response examples in cURL, Python and Node.js.

Base URL

Send every request over HTTPS to:

Base URL
https://nofy.encipher.co.tz

The same API also answers on https://ens.encipher.co.tz, the original host. Existing integrations can keep using it; new ones should use https://nofy.encipher.co.tz, which every example in these docs uses.

Authentication

v2 endpoints take a client-credentials Bearer token in the Authorization header. Mint one with Create a token; the Authentication guide covers expiry and keeping the secret safe. POST /v2/messages also requires an Idempotency-Key header.

Errors

Errors are JSON. Validation errors name the field; everything else carries a detail message.

400Validation failed, unknown tenant, or a bad channel/kind pairing.
401Missing or invalid token.
403Authenticated, but not with a client-credentials token.
413Request body over 5 MB.
429Tenant or client daily quota reached.

Endpoints

Messages

POST /v2/messages Send a message GET /v2/deliveries List deliveries

Tenants & devices

POST /v2/tenants Provision a tenant POST /v2/devices Register a device DELETE /v2/devices Deactivate devices

Authentication

POST /v1/oauth2/token/ Create a token

Legacy v1

POST /v1/notification/send/ Send (v1) GET /v1/notification/list/ List notifications (v1) POST /v1/device/device/register/ Register a device (v1) GET /v1/device/device/list/ List devices (v1)

Internal paths (Meta webhooks, profiling, admin callbacks) are intentionally unpublished.

Esc
↑↓ to move↵ to open