# Nervly Docs

> Notification infrastructure for Africa-first products

This file contains links to documentation sections following the llmstxt.org standard.

## Table of Contents

- [Erase a subscriber and delete their personal data (NDPR / right-to-erasure).](https://docs.nervly.io/docs/api/gateway/erase-subscriber.md): Anonymises the subscriber row, clears email, phone, device tokens, sets
- [Events](https://docs.nervly.io/docs/api/gateway/events.md): Events
- [Look up the status and event timeline for a single message by event ID.](https://docs.nervly.io/docs/api/gateway/get-event-status.md): Look up the status and event timeline for a single message by event ID.
- [Report gateway health.](https://docs.nervly.io/docs/api/gateway/get-health.md): Unauthenticated. Use this as your load-balancer health check and as a
- [Health](https://docs.nervly.io/docs/api/gateway/health.md): Health
- [Invoke a Model Context Protocol tool.](https://docs.nervly.io/docs/api/gateway/invoke-mcp-tool.md): Lets an AI agent operate the gateway the way an operator would: inspect
- [List messages with optional filters and cursor-based pagination.](https://docs.nervly.io/docs/api/gateway/list-messages.md): List messages with optional filters and cursor-based pagination.
- [MCP](https://docs.nervly.io/docs/api/gateway/mcp.md): MCP
- [Nervly Gateway API](https://docs.nervly.io/docs/api/gateway/nervly-gateway-api.md): Nervly is notification infrastructure for Africa-first products: one API call fans a message out across SMS, email, push, WhatsApp and voice, with ...
- [Receive a provider delivery receipt.](https://docs.nervly.io/docs/api/gateway/receive-delivery-receipt.md): Point each provider's webhook setting at
- [Acknowledges one relay event, removing it from the workspace's buffer.](https://docs.nervly.io/docs/api/gateway/relay-ack.md): The tunnel calls this after it has handed the event to the local receiver,
- [Accepts a recorded delivery event into the workspace's relay buffer.](https://docs.nervly.io/docs/api/gateway/relay-ingest.md): This is the event-posting path the platform's delivery pipeline writes to:
- [Reports the caller's workspace relay delivery state.](https://docs.nervly.io/docs/api/gateway/relay-status.md): Answers 'is the relay healthy for me': how many recorded delivery events
- [The authenticated, workspace-scoped tunnel a CLI dials out to.](https://docs.nervly.io/docs/api/gateway/relay-tunnel.md): The CLI opens a long-lived Server-Sent Events connection authenticated with
- [Relay](https://docs.nervly.io/docs/api/gateway/relay.md): Relay
- [Subscribers](https://docs.nervly.io/docs/api/gateway/subscribers.md): Subscribers
- [Trigger a notification.](https://docs.nervly.io/docs/api/gateway/trigger-notification.md): Accepts one event, resolves its priority, encodes it as Protobuf and
- [Trigger notifications in bulk.](https://docs.nervly.io/docs/api/gateway/trigger-notifications-bulk.md): Prefer this over looping on `POST /v1/events/trigger` when you have more
- [Update a subscriber's notification preferences.](https://docs.nervly.io/docs/api/gateway/update-subscriber-preferences.md): This is how you honour opt-outs. The workers read these preferences from
- [Webhooks](https://docs.nervly.io/docs/api/gateway/webhooks.md): Webhooks
- [Changelog](https://docs.nervly.io/docs/changelog.md): Public release notes for the Nervly platform and its components.
- [Managing API keys](https://docs.nervly.io/docs/dashboard/api-keys.md): Creating, storing, and revoking live and test API keys in the Developers dashboard.
- [Roles & permissions](https://docs.nervly.io/docs/dashboard/user-roles.md): Who in your organisation can create API credentials, and what each role can do.
- [How Nervly delivers a notification](https://docs.nervly.io/docs/explanation/how-nervly-works.md): The delivery pipeline, channel selection, failover and circuit breaking, and the security model — for architects evaluating Nervly.
- [Why Voice OTP is a carrier-redundant fallback](https://docs.nervly.io/docs/explanation/voice-otp-fallback.md): The design reasoning behind the Voice channel — why a phone call is a different failure domain to an SMS, and how two carriers make the call itself...
- [Authentication](https://docs.nervly.io/docs/guides/authentication.md): API key formats, live vs test keys, cryptographic verification, and webhook signatures.
- [Bulk sending](https://docs.nervly.io/docs/guides/bulk-sending.md): Send many notifications in one call instead of looping on the single-event endpoint.
- [Channels & providers](https://docs.nervly.io/docs/guides/channels-and-providers.md): Which channels Nervly delivers on, which providers back each one, and how a channel is chosen for each event.
- [Delivery receipts](https://docs.nervly.io/docs/guides/delivery-receipts.md): Reading message delivery outcomes, verifying provider webhook signatures, and decoding normalized receipt telemetry.
- [Errors](https://docs.nervly.io/docs/guides/errors.md): The error contract, what each code means, and what is safe to retry.
- [Failover & circuit breakers](https://docs.nervly.io/docs/guides/failover-and-circuit-breakers.md): How Nervly takes a failing provider out of rotation without dropping your traffic.
- [Idempotency](https://docs.nervly.io/docs/guides/idempotency.md): Make retries safe so a network timeout never becomes a duplicate notification.
- [MCP endpoint](https://docs.nervly.io/docs/guides/mcp.md): Let an AI agent inspect your Nervly gateway without giving it shell access.
- [Reading message status](https://docs.nervly.io/docs/guides/message-status.md): Query message delivery outcomes, event timelines, and SDK lookups.
- [Priorities & routing](https://docs.nervly.io/docs/guides/priorities-and-routing.md): How priority selects a JetStream lane, a channel, and an email provider, and how events flow through the broker.
- [Provider credentials](https://docs.nervly.io/docs/guides/provider-credentials.md): Bring-your-own provider keys, envelope encryption guarantees, connection testing, and priority cascades.
- [Quotas and billing](https://docs.nervly.io/docs/guides/quotas-and-billing.md): Monthly BYO subscription pricing, Paystack integration, usage metering, and dunning lifecycle.
- [Rate limits](https://docs.nervly.io/docs/guides/rate-limits.md): Two-tier rate limiting architecture, Retry-After headers, and abuse mitigation.
- [Subscriber preferences](https://docs.nervly.io/docs/guides/subscriber-preferences.md): Workspace-scoped preferences, Nigerian NCC 2442 DND compliance, and NDPR erasure.
- [Send a Voice OTP in 5 minutes](https://docs.nervly.io/docs/guides/voice-otp-quickstart.md): A five-minute tutorial that places a spoken one-time passcode to a phone using the TypeScript SDK or standard HTTP client code in nine other langua...
- [Configure Voice failover (Termii → Infobip)](https://docs.nervly.io/docs/guides/voice-provider-failover.md): How to add two voice carriers in the dashboard and let Nervly fail a call over when the first one stalls.
- [Workspaces and members](https://docs.nervly.io/docs/guides/workspaces-and-members.md): Multi-tenant workspace boundaries, team roles, RBAC, and single-use invites.
- [Nervly Documentation](https://docs.nervly.io/docs.md): Notification infrastructure for Africa-first products — one API call, every channel.
- [Quickstart](https://docs.nervly.io/docs/quickstart.md): Send your first notification through Nervly in under ten minutes.
- [TypeScript SDK](https://docs.nervly.io/docs/reference/sdk.md): Version, installation, and compatibility for the official @nervly/sdk client.
- [Voice](https://docs.nervly.io/docs/reference/voice.md): The Voice channel request contract, E.164 phone rules, TTS digit pacing, and the error codes a voice event can end on.
- [Security policy](https://docs.nervly.io/docs/security.md): How to report a vulnerability in Nervly, our response commitments, and what is in scope.