Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Every endpoint of the OMNI API, with its scope, parameters, an example in three languages, the answer and the errors.
https://api.fireflo.au/v1. Every request needs a key:
Authorization: Bearer $OMNI_API_KEY. See The OMNI API for how it
fits together, and Conventions for idempotency, paging and
limits.
| Group | What it does |
|---|---|
| Account | Who a key is; the events webhooks can carry |
| Messages | One message to one person, with failover between channels |
| Routes | The channels a message is tried on, in order |
| Templates | One message, written once per channel |
| Contacts | People, their fields, tags and consent |
| Conversations | The Inbox: threads, replies, assignment |
| Senders | Every sender ID, number and bot messages can come from |
| Calls | The call log; ringing someone into an IVR or to a voice agent |
| Usage | What was sent, received and called, and what it cost |
| Webhooks | Endpoints and what was sent to them |
| WhatsApp message templates and Meta’s approval | |
| SMS | Sender IDs, DLT templates and the gateway balance |
https://api.fireflo.au/v1/openapi.json), each with a panel that sends a real request
with your key. Use a test key there.
Every scope and every webhook event is on Scopes and events.