For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

CLEAK — WhatsApp API

Introduction
1. Login → get jwt_token
5. GET /api/api-clients → verify both keys listed
3. POST /api/api-clients → create key (campaign_sender_with_webhook)
2. GET /api/api-clients/scopes → see available scopes
4. POST /api/api-clients → create read-only key (for error tests)
18. DELETE /api/api-clients/:clientId → revoke main key
17. GET /api/api-clients/:clientId/logs → confirm audit trail
20. DELETE /api/api-clients/:readOnlyClientId → cleanup read-only key
19. GET /api/whatsapp/templates with REVOKED key → expect 401
8. GET /api/whatsapp/campaigns → verify read access
7. GET /api/whatsapp/templates → save first APPROVED template name
6. GET /api/whatsapp/phone-numbers → save phone_number_id
9. POST campaigns/send-manual → plain template (no body variables)
12. GET campaigns/:id/button-analytics → check status (uses JWT — not in external API)
10. POST campaigns/send-manual → template WITH body variables ({{1}}, {{2}})
11. POST campaigns/send-direct → existing CLEAK customer group
15. 401 — No API key or JWT provided at all
14. 401 — Invalid API key
13. 403 — Wrong scope (read-only key trying to send campaign)
16. 400 — Missing required field (no manualPhoneNumbers)

CLEAK — WhatsApp API

Introduction

||View as Markdown|

End-to-end tests for the CLEAK External API Key system. Run requests in order.
Phase 1 uses JWT (Bearer).
Phase 2+ uses x-api-key only.
Variables auto-populate via test scripts.

Was this page helpful?

Login → get jwt_token