Bizmitra Notify API

One unified HTTP API for transactional messaging across every channel — like Resend, but channel-agnostic. Send through the same endpoint, swap providers without touching your code, and track delivery end to end.

Base URL

All endpoints are served under the /api prefix.

https://your-domain.com/api

Authentication

Authenticate with a tenant-scoped API key via the Authorization header using the Bearer scheme. Generate keys from the Developer Dashboard → API Keys.

Authorization: Bearer nk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Quickstart

Send your first email in under a minute:

 Copycurl -X POST https://your-domain.com/api/messages/send \
  -H "Authorization: Bearer nk_live_xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "email",
    "to": "jane@example.com",
    "subject": "Welcome to Acme",
    "event_key": "user_welcome",
    "transaction_id": "ord_8421",
    "data": {
      "first_name": "Jane",
      "activation_url": "https://acme.com/activate/abc123"
    }
  }'

You'll get back a queued message ID you can correlate with webhook callbacks:

{
  "message_id": "01HZX7K...",
  "status": "queued"
}

Channels & Providers

A channel is the medium (email, SMS, WhatsApp, push). A provider is the underlying vendor that actually delivers the message. Notify abstracts the two so you can route, fail over and price independently.

Templates & Events

Every send references a server-side template via event_key. Templates are created from the Developer Dashboard and bound to a channel and tenant. The runtime resolves event_key + channel + is_active=true and renders the body with the values in data.

Idempotency

Pass a unique transaction_id on every request. Notify derives a business-event ID from it ({transaction_id}_{action}), so safe retries from your side will not double-send. Reuse the same transaction_id when retrying a failed network call.

Rate Limits & Quotas

Defaults shown — contact us for higher tiers.

Send a Message

The single endpoint you use for every channel. Today only email is routable.

Headers

Body Parameters

Example Request

 CopyPOST /api/messages/send HTTP/1.1
Host: your-domain.com
Authorization: Bearer nk_live_xxxxxxxx
Content-Type: application/json

{
  "channel": "email",
  "to": "customer@example.com",
  "subject": "Your order has shipped",
  "event_key": "order_shipped",
  "transaction_id": "ord_8421",
  "data": {
    "order_id": "8421",
    "tracking_url": "https://track.acme.com/8421"
  }
}

Success Response 200 OK

{
  "message_id": "01HZX7K2A0Q8VVQH...",
  "status": "queued"
}

Error Responses

Ingest a Business Event

Forward business events from your apps (ERP, billing, CRM) so Notify can react with the correct template + channel. Events are deduplicated by event_id and processed asynchronously.

Body Parameters

Response

{ "status": "accepted" }

Provider Webhooks (inbound)

Endpoint Notify exposes for providers to call. Configure this URL in your provider dashboard (e.g. Brevo → Transactional → Webhooks) and Notify will normalize the payload into a unified delivery-status lifecycle. Signatures are verified per provider — unsigned or invalid requests get 403.

Supported {provider} values today: brevo.

Health Check

Unauthenticated liveness probe — safe for uptime monitors and load balancers.

{ "status": "ok", "service": "bizmitra-notify" }

Errors

Errors use standard HTTP status codes with a JSON body:

{ "error": "Invalid template" }

For validation failures, Laravel's default 422 shape applies with a message and errors map keyed by field.

Delivery Status Lifecycle

Once dispatched, a message moves through these normalized states (the same vocabulary regardless of provider):

Changelog