Ana MNotifications
Quickstart

From credential to delivery.

Use a non-production account and synthetic content for your first test. Every step is available in the console.

1. Run the native service

docker compose up -d --build

Open this origin’s console. Local setup supplies development organization credentials through the documented operator setup. The public console never creates an unauthenticated organization or supplies a built-in credential. For hosted use, obtain an organization API key from your operator.

2. Connect and provision a tenant

Paste an organization key with admin, read and send scopes in the console. Keys stay in page memory. In your application keep these keys on the backend.

POST /v1/tenants
Authorization: Bearer <organization-key>
Content-Type: application/json

{"external_ref":"workspace-001","name":"Integration workspace"}

Use the returned tenant_header on subsequent tenant calls, for example X-Anam-Tenant: ref:workspace-001. Use an organization admin key for provisioning.

3. Connect a provider

Choose a registered connector in the console. Organization routes use PUT /v1/providers/{providerId}/credentials. For tenant-owned WhatsApp numbers, create a /v1/sender-connections resource, verify it, then set it as the default with its current revision. Twilio and Zavu credentials and onboarding are provider-specific; ownership, revisions and API operations are native.

Credential values are encrypted server-side. Jurisdiction and transfer safeguards remain required where applicable. Pasting a key does not migrate a number, activate a paid resource or approve a template.

4. Create a recipient and template

Use Recipients to register your test contact. Use Templates to create a definition and a version, preview it and activate it. Create an inbox template on channel push. For a tenant WhatsApp sender, publish the version to its connection, create the provider template, submit it, read its approval state, and activate only after approval.

Editing a template creates a new version. A pending tenant draft does not replace an active shared version. WhatsApp approval belongs to the provider/Meta and is never fabricated by this console. Twilio sandbox availability does not guarantee approval or production sender readiness.

5. Send and inspect

POST /v1/messages
Authorization: Bearer <backend-key>
X-Anam-Tenant: ref:workspace-001
Idempotency-Key: <stable-intent-key>
Content-Type: application/json

{"recipient":{"external_ref":"test-recipient"},"template":{"key":"document.ready"},"channel_policy":{"chain":["email"]},"variables":{}}

Read the returned message IDs and GET /v1/messages/{id}. The console records request ID, HTTP status and timing. A timeout does not prove that a write failed: retry the same intent with the same key, or reconcile its operation before creating another.

6. Test the browser and webhooks

Browser tools can issue a resource-bound grant, renew its authority while explicitly active, list the inbox and listen to SSE. The permission test creates a clearly labeled local browser notification. Real Web Push additionally requires VAPID, a reachable push service and the configured server-to-server authority. Missing authority stays blocked.

Verify signatures and replay rules before consuming delivery events. Your application remains responsible for current user/resource authorization.