.env.example

# @dojocoding/whatsapp — environment variables
#
# Copy this file to `.env` and fill in your real values. The SDK itself does
# NOT auto-load `.env`; your application is responsible for loading it (e.g.,
# via `dotenv/config`, Node's built-in `--env-file=.env`, or your framework's
# loader). The names below are the conventions this project's docs and tests
# follow — pick any names you like in your own app.
#
# See docs/compliance.md for what each value is used for and which Meta rules
# it intersects with.

# ─────────────────────────────────────────────────────────────────────────
# Required for the real (non-mock) WhatsAppClient
# ─────────────────────────────────────────────────────────────────────────

# The phone-number id of the WhatsApp Business phone you send from.
# URL: POST /{phoneNumberId}/messages
# NOT the display number — this is Meta's internal id.
WHATSAPP_PHONE_NUMBER_ID=

# The WhatsApp Business Account id this phone belongs to.
# URL: GET /{wabaId}/message_templates
# A WABA can host multiple phone numbers; one SDK instance per phone.
WHATSAPP_WABA_ID=

# Long-lived BISU or System User access token. Bearer credential.
# Rotate via Meta Business Manager. Never commit a real token.
WHATSAPP_TOKEN=

# Meta App Secret — used to verify HMAC-SHA256 signatures on inbound
# webhooks (`X-Hub-Signature-256`). Treat as production-critical.
WHATSAPP_APP_SECRET=

# ─────────────────────────────────────────────────────────────────────────
# Required for the webhook receiver (you choose the value)
# ─────────────────────────────────────────────────────────────────────────

# Shared secret you also paste into Meta's webhook configuration UI. The
# receiver compares it (in constant time) to `hub.verify_token` during the
# GET handshake. Pick anything sufficiently random; rotate by updating both
# sides.
WHATSAPP_VERIFY_TOKEN=

# ─────────────────────────────────────────────────────────────────────────
# Optional toggles
# ─────────────────────────────────────────────────────────────────────────

# When set to `mock`, `pickWhatsAppClient(...)` returns a `MockWhatsAppClient`
# that records sends in memory and never touches the network. Useful for CI
# and local dev. See docs/mock.md.
# WHATSAPP_MODE=mock

# When set to `1`, the (currently nightly) parity / integration tests that
# hit the real Meta sandbox are unskipped. Leave unset for normal CI.
# WHATSAPP_E2E=1