Getting Started
Washeej API v1
The canonical API for new integrations. One authentication model, unified webhooks, OAuth Connect, and scoped access — for Meta Cloud API and Device/QR channels.
Recommended for new projects
Use this reference for all new work. Legacy
/external-api and /device-api/v1 remain available for existing clients without breaking changes.
Base URL
Production
https://app.washeej.com/v1
Live environment only
There is no sandbox. All requests run against your live account — validate payloads carefully before sending.
Quick Start
1
Whitelist your server IP
Dashboard → Developer Tools → IP Whitelist (required for API key auth).
2
Copy credentials
Grab
client-id and client-secret from Developer Tools (or create an OAuth app).
3
Verify connectivity
Call the public ping endpoint, then an authenticated account request.
4
Connect a number
Device/QR:
POST /devices → QR or pairing. Cloud: hosted onboarding — see Devices.
5
Send & listen
Send a message or template with an explicit
whatsapp_account_id, then register webhooks.
GET
/ping
Public
https://app.washeej.com/v1/ping
Health check (public, no authentication).
cURL
curl https://app.washeej.com/v1/ping
Response
{
"ok": true,
"data": {
"status": "ok",
"version": "v1"
},
"meta": {
"request_id": "uuid"
}
}
cURL — authenticated account
curl -H "client-id: YOUR_CLIENT_ID" \
-H "client-secret: YOUR_CLIENT_SECRET" \
https://app.washeej.com/v1/account
Scenario guides
Start with the playbook, then jump to the pattern you need:
- Integration Playbook — full SaaS checklist
- Channel Selection — multi-number sending
- Session Window vs Templates — 24h rules
- Session Media — PDFs & media inside the window
- Interactive Messages — CTA, lists, location
- Template Media Headers — native PDF/file templates
- Dynamic Invoice Link — URL in template text
- Authentication OTP — login codes
What to read next
- Authentication — API keys, IP whitelist, OAuth Bearer
- Devices — QR / Cloud numbers, quota, hosted onboarding
- Messages — session send surface
- Templates — approved Cloud templates
- Webhooks — events, signatures, delivery
- Machine-readable docs — Markdown for agents /
llms.txt