Developer documentation

Build wɔ NotifyBridge

Guides, API reference, ne integration patterns ma Ghana ne African applications.

API Overview Download OpenAPIInteractive API explorer
Start here

Quick Start

Create account, generate API key, send first SMS wɔ 5 minutes.

Kenkan bio
API

Authentication

API keys, bearer tokens, sandbox vs production, ne key rotation.

Kenkan bio
API

Send Messages

SMS, WhatsApp, email, push, voice OTP — formats ne examples.

Kenkan bio
API

Webhooks

Delivery receipts, opt-out events, ne signature verification.

Kenkan bio
API

Event Triggers

Fire dashboard events wɔ channel priority ne fallback.

Kenkan bio
Guide

Compliance & Consent

Opt-in, DND lists, healthcare-safe messaging, Ghana regulatory notes.

Kenkan bio
Guide

Ghana Setup Guide

Sender ID registration, +233 formatting, Hubtel routing, best practices.

Kenkan bio

OpenAPI tag reference

Spec no wɔ resource groups mu. Import openapi.yaml into Postman anaa Redocly.

Auth

  • POST /auth/login
  • POST /auth/register
Hwɛ wɔ API explorer mu

System

  • GET /health
Hwɛ wɔ API explorer mu

Messages

  • POST /messages/send
  • POST /messages/bulk
Hwɛ wɔ API explorer mu

Events

  • POST /events/trigger
  • GET /events
Hwɛ wɔ API explorer mu

Contacts

  • GET /contacts
  • POST /contacts/import
Hwɛ wɔ API explorer mu

Campaigns

  • GET /campaigns
  • POST /campaigns/{id}/send
Hwɛ wɔ API explorer mu

Segments

  • POST /segments
  • POST /segments/preview
Hwɛ wɔ API explorer mu

Templates

  • GET /templates
  • POST /templates
Hwɛ wɔ API explorer mu

API Keys

  • GET /api-keys
  • POST /api-keys
Hwɛ wɔ API explorer mu

Delivery Logs

  • GET /delivery-logs
  • GET /delivery-logs/export
Hwɛ wɔ API explorer mu

Analytics

  • GET /analytics/overview
  • GET /analytics/costs
Hwɛ wɔ API explorer mu

Billing

  • GET /billing/wallet
  • GET /billing/top-up-options
  • POST /billing/top-up
Hwɛ wɔ API explorer mu

Webhooks

  • POST /webhook-endpoints
  • POST /webhook-endpoints/{id}/test
Hwɛ wɔ API explorer mu

Compliance

  • POST /compliance/suppression
  • POST /compliance/check-message
Hwɛ wɔ API explorer mu

Organizations

  • GET /organizations/current
  • POST /organizations/invite
Hwɛ wɔ API explorer mu

Providers

  • GET /providers
  • POST /providers/{id}/health-check
Hwɛ wɔ API explorer mu

Admin

  • GET /admin/tenants
  • POST /admin/tenants/{id}/impersonate
Hwɛ wɔ API explorer mu
Download OpenAPIInteractive API explorerAPI reference overview

Popular guides

Bulk SMS wɔ Ghana
Healthcare appointment reminders
Fintech OTP & transaction alerts
Pricing & billing wɔ GHS

Need help integrating?

Developer support responds wɔ 24 hours mu. Enterprise customers wɔ dedicated Slack.

Create Free Account
Nnwuma — Nnwuma, API Reference ne Integration | NotifyBridge