API Guides
WhatsApp Business API
Send WhatsApp messages, manage templates, and receive signed events with Notify Africa.
Use the Notify Africa WhatsApp Business API to integrate an application with the WhatsApp Business Account connected to your Notify Africa account.
Get StartedPrepare WhatsApp in the Portal and make the first WABA Developer API request.TemplatesCreate, validate, submit, sync, and monitor WhatsApp templates.WebhooksConfigure callbacks in the Portal and process signed WhatsApp events.MCP ServerMCPExpose WhatsApp text and template send tools to MCP-compatible agents.
Responsibilities
| Action | Where it happens |
|---|---|
| Create a Notify Africa account and activate WhatsApp | Notify Africa Portal |
| Complete Meta onboarding and connect WhatsApp assets | Notify Africa Portal |
| Check connection readiness | Notify Africa Portal |
| Create or rotate a WABA API key | Notify Africa Portal |
| Configure webhook URL, events, and signing secret | Notify Africa Portal |
| Create or curate Marketing and Utility templates | Notify Africa Portal or Developer API |
| Create Authentication OTP templates | Developer API |
| Send text and template messages | Developer API |
| Queue a webhook test | Developer API |
| Inspect webhook deliveries and endpoint health | Notify Africa Portal |
| Receive and verify events | Your application |
Portal actions are account-management operations. They are not Developer API endpoints.
Authentication
Every Developer API request uses a WABA-authorized API key:
Authorization: Bearer ntfy_your_api_key
Content-Type: application/jsonKeep the key on your server. Do not embed it in browser or mobile application code.
Base URL
Use the environment base URL supplied by Notify Africa. Production examples use:
https://api.notify.africaThe WABA Developer API prefix is:
/v1/waba-apiDeveloper Journey
Set up WhatsApp in the Portal.
Resolve connection readiness blockers.
Create a WABA-authorized API key.
Configure a developer webhook in the Portal.
Create and submit a template through the Developer API.
Wait for template approval.
Send a message.
Process signed status events.
Developer API Surface
Templates
| Method | Path | Purpose |
|---|---|---|
POST | /v1/waba-api/templates | Create and submit a WhatsApp template |
GET | /v1/waba-api/templates | List owned templates |
GET | /v1/waba-api/templates/:templateId | Retrieve one template |
PATCH | /v1/waba-api/templates/:templateId | Update mutable fields |
DELETE | /v1/waba-api/templates/:templateId | Delete the template |
POST | /v1/waba-api/templates/:templateId/validate | Validate bindings |
POST | /v1/waba-api/templates/:templateId/preview | Render a local logical preview |
POST | /v1/waba-api/templates/:templateId/sync | Refresh provider state |
GET | /v1/waba-api/templates/:templateId/status | Read status and synchronization state |
Messages
| Method | Path | Purpose |
|---|---|---|
POST | /v1/waba-api/messages/text | Queue freeform text inside an open service window |
POST | /v1/waba-api/messages/template | Queue an approved template message |
These are the complete API-key-authenticated operations. Webhook management, delivery inspection, and queuing a webhook test all stay in the Portal.
Start Here
Setup And ConnectionUnderstand Portal-managed onboarding, readiness, and selected assets.MessagingSend freeform text inside a service window or approved template messages.API ReferenceReview every public WABA Developer API endpoint.MCP ServerMCPConfigure @notifyafrica/whatsapp-mcp-server for agent workflows.GuidesFollow task-oriented WhatsApp integration flows.ErrorsHandle validation, setup, provider, and webhook errors.