Skip to content
IconEngage

Developers

The public REST API: authentication, sending messages, event webhooks, signatures, limits and errors.

  1. The IconEngage public APIWhat the public REST API lets your own systems do, where it lives, how it is versioned and which resources it offers.
  2. Create and manage API keysCreate an API key for each system that calls IconEngage, choose its permissions, copy it once, and revoke or replace it.
  3. Authenticate API requestsSend your API key in the Authorization header, understand what the key is allowed to do, and fix 401 and 403 answers.
  4. Send a message with the APISend a text or template WhatsApp message, upload media, avoid duplicate sends with an idempotency key, and check where a message has got to.
  5. Event webhooksHave IconEngage POST a signed event to your system when a message arrives, a status changes, a template is decided and more; check deliveries, replay them and send test events.
  6. Verify webhook signaturesCheck the X-IconEngage-Signature header on every event webhook delivery, with working Node.js and Python examples.
  7. Rate limits and errorsRead the quota headers on every API response, handle 429s correctly, and understand the error format and the codes you are most likely to meet.

Still need help?

Write to us at [email protected] and tell us what you were trying to do. Already a customer? Sign in to IconEngage — the same articles are under Help in the app.