Developer documentation

Build with NotifyBridge

Guides, API reference, and integration patterns for developers building messaging into Ghana and African applications.

API Overview Download OpenAPIInteractive API explorer
Start here

Quick Start

Create an account, generate an API key, and send your first SMS in 5 minutes.

Read more
API

Authentication

API keys, bearer tokens, sandbox vs production environments, and key rotation.

Read more
API

Send Messages

SMS, WhatsApp, email, push, and voice OTP — request formats, parameters, and examples.

Read more
API

Webhooks

Configure delivery receipts, opt-out events, and signed payload verification.

Read more
API

Event Triggers

Fire dashboard-configured events with channel priority and automatic fallback.

Read more
Guide

Compliance & Consent

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

Read more
Guide

Ghana Setup Guide

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

Read more

OpenAPI tag reference

The spec is organized by resource group. Import openapi.yaml into Postman, Redocly, or your favorite OpenAPI client.

Auth

  • POST /auth/login
  • POST /auth/register
View in API explorer

System

  • GET /health
View in API explorer

Messages

  • POST /messages/send
  • POST /messages/bulk
View in API explorer

Events

  • POST /events/trigger
  • GET /events
View in API explorer

Contacts

  • GET /contacts
  • POST /contacts/import
View in API explorer

Campaigns

  • GET /campaigns
  • POST /campaigns/{id}/send
View in API explorer

Segments

  • POST /segments
  • POST /segments/preview
View in API explorer

Templates

  • GET /templates
  • POST /templates
View in API explorer

API Keys

  • GET /api-keys
  • POST /api-keys
View in API explorer

Delivery Logs

  • GET /delivery-logs
  • GET /delivery-logs/export
View in API explorer

Analytics

  • GET /analytics/overview
  • GET /analytics/costs
View in API explorer

Billing

  • GET /billing/wallet
  • GET /billing/top-up-options
  • POST /billing/top-up
View in API explorer

Webhooks

  • POST /webhook-endpoints
  • POST /webhook-endpoints/{id}/test
View in API explorer

Compliance

  • POST /compliance/suppression
  • POST /compliance/check-message
View in API explorer

Organizations

  • GET /organizations/current
  • POST /organizations/invite
View in API explorer

Providers

  • GET /providers
  • POST /providers/{id}/health-check
View in API explorer

Admin

  • GET /admin/tenants
  • POST /admin/tenants/{id}/impersonate
View in API explorer
Download OpenAPIInteractive API explorerAPI reference overview

Popular guides

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

Need help integrating?

Our developer support team responds within 24 hours. Enterprise customers get dedicated Slack channels.

Create Free Account
Documentation — Guides, API Reference & Integration | NotifyBridge