NotifyBD API

GET /api/v1/me

Your account, balance and plan. Who the key belongs to, the balance in taka, the account's time zone and current local time, and the plan's limits (including notifications per month and how many are used this month; null = unlimited).

Example

curl https://app.notify.bd/api/v1/me \
  -H "X-API-Key: YOUR_API_KEY"

Response 200

{
  "ok": true,
  "name": "Rahim Uddin",
  "username": "rahim@example.com",
  "role": "user",
  "now": "2026-09-28T10:15",
  "balance": 120.0,
  "currency": "BDT",
  "timeZone": "Asia/Dhaka",
  "plan": {
    "name": "Pro",
    "expiresAt": "2026-10-28T00:00:00Z",
    "expired": false,
    "maxReminders": 300,
    "maxMonitors": 20,
    "notificationsPerMonth": 600,
    "notificationsUsedThisMonth": 42,
    "sms": true,
    "whatsapp": true,
    "email": true,
    "smsRate": 0.35,
    "whatsappRate": 0.8
  }
}

POST /api/v1/reminders

Create a reminder.

JSON body

Example

curl -X POST https://app.notify.bd/api/v1/reminders \
  -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" \
  -d '{"title":"example.com renewal","repeat":"yearly","date":"2026-12-01","time":"10:00","phases":[15,7,1,0],"methods":["app","sms"]}'

Response 201

{
  "ok": true,
  "data": {
    "id": "3f1c…",
    "title": "example.com renewal",
    "repeat": "yearly",
    "date": "2026-12-01",
    "time": "10:00",
    "phases": [
      15,
      7,
      1,
      0
    ],
    "methods": [
      "app",
      "sms"
    ],
    "requireAck": true,
    "alarm": false,
    "repeatEveryMin": 10,
    "maxRepeats": 3,
    "active": true,
    "nextRunAt": "2026-11-16T04:00:00Z"
  }
}

GET /api/v1/reminders

List reminders. All your reminders, sorted by title.

Example

curl https://app.notify.bd/api/v1/reminders -H "X-API-Key: YOUR_API_KEY"

Response 200

{
  "ok": true,
  "data": [
    {
      "id": "3f1c…",
      "title": "Go to play",
      "repeat": "daily",
      "time": "17:00",
      "active": true
    }
  ]
}

GET /api/v1/reminders/{id}

Get one reminder.

Path parameters

Example

curl https://app.notify.bd/api/v1/reminders/REMINDER_ID -H "X-API-Key: YOUR_API_KEY"

Response 200

{
  "ok": true,
  "data": {
    "id": "3f1c…",
    "title": "Go to play",
    "active": true
  }
}

POST /api/v1/reminders/{id}/pause

Pause a reminder. Stops it from firing. Use /resume to turn it back on.

Path parameters

Example

curl -X POST https://app.notify.bd/api/v1/reminders/REMINDER_ID/pause -H "X-API-Key: YOUR_API_KEY"

Response 200

{
  "ok": true,
  "data": {
    "id": "3f1c…",
    "active": false
  }
}

POST /api/v1/reminders/{id}/resume

Resume a reminder.

Path parameters

Example

curl -X POST https://app.notify.bd/api/v1/reminders/REMINDER_ID/resume -H "X-API-Key: YOUR_API_KEY"

Response 200

{
  "ok": true,
  "data": {
    "id": "3f1c…",
    "active": true
  }
}

DELETE /api/v1/reminders/{id}

Delete a reminder. Deletes the reminder and its history. Cannot be undone.

Path parameters

Example

curl -X DELETE https://app.notify.bd/api/v1/reminders/REMINDER_ID -H "X-API-Key: YOUR_API_KEY"

Response 200

{
  "ok": true
}

POST /api/v1/answer/{occurrenceId}

Answer a waiting reminder. yes = done (stops asking); snooze and notyet both ask again after the reminder's repeatEveryMin. The occurrenceId comes from GET /notifications (items with waitingForAnswer = true).

Path parameters

JSON body

Example

curl -X POST https://app.notify.bd/api/v1/answer/OCCURRENCE_ID \
  -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" -d '{"answer":"yes"}'

Response 200

{
  "ok": true,
  "message": "Great! “Go to play” is done."
}

POST /api/v1/notify

Notify yourself now. Sends a notification to your own devices right away — handy for backups, cron jobs and scripts. It goes through the same queue; SMS/WhatsApp are charged from your balance. Counts toward the plan's monthly notification limit.

JSON body

Example

curl -X POST https://app.notify.bd/api/v1/notify \
  -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" \
  -d '{"title":"Backup finished","message":"db.bak 2.3 GB","methods":["app"],"severity":"success"}'

Response 202

{
  "ok": true,
  "id": "9b2e…",
  "deliveries": [
    {
      "method": "app",
      "status": "queued",
      "cost": 0,
      "error": null
    }
  ]
}

GET /api/v1/notifications

Read your inbox. Latest notifications, newest first. waitingForAnswer = a reminder is still waiting for Yes (answer it with POST /answer).

Query parameters

Example

curl "https://app.notify.bd/api/v1/notifications?unread=true&limit=20" -H "X-API-Key: YOUR_API_KEY"

Response 200

{
  "ok": true,
  "data": [
    {
      "id": "9b2e…",
      "kind": "reminder",
      "severity": "info",
      "title": "Go to play",
      "body": "",
      "createdAt": "2026-09-28T11:00:00Z",
      "read": false,
      "occurrenceId": "5d0a…",
      "waitingForAnswer": true
    }
  ]
}

POST /api/v1/monitors

Watch a site or server.

JSON body

Example

curl -X POST https://app.notify.bd/api/v1/monitors \
  -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" \
  -d '{"name":"Shop","kind":"http","target":"https://shop.example.com","intervalSec":300,"methods":["app"]}'

Response 201

{
  "ok": true,
  "data": {
    "id": "c7aa…",
    "name": "Shop",
    "kind": "http",
    "target": "https://shop.example.com",
    "intervalSec": 300,
    "methods": [
      "app"
    ],
    "active": true,
    "state": "unknown"
  }
}

GET /api/v1/monitors

List monitors. With state (up / down / unknown / paused), last check time, latency and last error.

Example

curl https://app.notify.bd/api/v1/monitors -H "X-API-Key: YOUR_API_KEY"

Response 200

{
  "ok": true,
  "data": [
    {
      "id": "c7aa…",
      "name": "Shop",
      "state": "up",
      "latencyMs": 182,
      "lastCheckAt": "2026-09-28T11:02:10Z"
    }
  ]
}

DELETE /api/v1/monitors/{id}

Delete a monitor.

Path parameters

Example

curl -X DELETE https://app.notify.bd/api/v1/monitors/MONITOR_ID -H "X-API-Key: YOUR_API_KEY"

Response 200

{
  "ok": true
}

GET /api/v1/users admin key

List your users.

Example

curl https://app.notify.bd/api/v1/users -H "X-API-Key: YOUR_ADMIN_KEY"

Response 200

{
  "ok": true,
  "data": [
    {
      "id": "…",
      "name": "Rahim Uddin",
      "username": "rahim@example.com",
      "active": true,
      "balance": 100.0,
      "plan": "Pro"
    }
  ]
}

POST /api/v1/users admin key

Create a user.

JSON body

Example

curl -X POST https://app.notify.bd/api/v1/users \
  -H "X-API-Key: YOUR_ADMIN_KEY" -H "Content-Type: application/json" \
  -d '{"name":"Rahim Uddin","email":"rahim@example.com","password":"secret123","phone":"01712345678"}'

Response 201

{
  "ok": true,
  "data": {
    "id": "…",
    "username": "rahim@example.com",
    "active": true
  }
}

PUT /api/v1/users/{email}/password admin key

Change a user's password. Sets a new password and signs the user out everywhere.

Path parameters

JSON body

Example

curl -X PUT https://app.notify.bd/api/v1/users/rahim@example.com/password \
  -H "X-API-Key: YOUR_ADMIN_KEY" -H "Content-Type: application/json" -d '{"password":"newSecret1"}'

Response 200

{
  "ok": true,
  "message": "Password updated. The user's other sessions are signed out."
}

PUT /api/v1/users/{email}/status admin key

Activate or suspend a user. active false suspends the user (signed out, no notifications).

Path parameters

JSON body

Example

curl -X PUT https://app.notify.bd/api/v1/users/rahim@example.com/status \
  -H "X-API-Key: YOUR_ADMIN_KEY" -H "Content-Type: application/json" -d '{"active":false}'

Response 200

{
  "ok": true,
  "data": {
    "username": "rahim@example.com",
    "active": false
  }
}

POST /api/v1/users/{email}/topup admin key

Add or deduct balance. Positive amount adds taka to the user's balance, negative deducts.

Path parameters

JSON body

Example

curl -X POST https://app.notify.bd/api/v1/users/rahim@example.com/topup \
  -H "X-API-Key: YOUR_ADMIN_KEY" -H "Content-Type: application/json" -d '{"amount":100,"note":"bKash 8H3K2"}'

Response 200

{
  "ok": true,
  "balance": 100.0
}

GET /api/v1/topics admin key

List your channels. Channels (topics) with subscriber counts.

Example

curl https://app.notify.bd/api/v1/topics -H "X-API-Key: YOUR_ADMIN_KEY"

Response 200

{
  "ok": true,
  "data": [
    {
      "id": "…",
      "name": "Server alerts",
      "open": true,
      "subscribers": 42
    }
  ]
}

POST /api/v1/broadcast admin key

Broadcast. Message all your users, or one channel's subscribers. SMS/WhatsApp are charged to your balance.

JSON body

Example

curl -X POST https://app.notify.bd/api/v1/broadcast \
  -H "X-API-Key: YOUR_ADMIN_KEY" -H "Content-Type: application/json" \
  -d '{"title":"Server maintenance tonight","methods":["app"],"severity":"warning"}'

Response 202

{
  "ok": true,
  "id": "…",
  "recipients": 87
}

GET /api/public/plans

Plans and prices. No key needed. The active plans with price (BDT), days, notifications per month (null = unlimited), reminders, monitors, fastest check, SMS/WhatsApp rates and API access. Cached 5 minutes; CORS open.

curl https://app.notify.bd/api/public/plans