Platform
Overview
What Aux0 is, what it connects, and how the pieces fit together.
Aux0 connects accounts your users already hold — a mailbox, a calendar, an address book — and gives you one API to read and write on them.
The product is three things:
- An auth flow your users complete on a page you brand, so no credential reaches your product.
- A unified API where a Gmail thread, a Microsoft Graph conversation and
an IMAP mailbox are the same object and
provideris a field, not a code path. - The operational layer that keeps those accounts working: incremental sync that survives a reconnect, quota pacing inside each provider's own windows, cursor recovery, and token refresh.
The third one is the part that is hard to build and easy to underestimate.
How a connection happens
sequenceDiagram
participant U as Your user
participant Y as Your product
participant A as aux0
participant P as The provider
Y->>A: POST /v1/hosted_auth { end_user_id }
A-->>Y: { url }
Y->>U: Send them the link
U->>A: Opens the page, links the account
A->>P: Establishes the session
A-->>Y: webhook account.connected { account_id }
A->>P: Backfills recent history
A-->>Y: webhook account.sync_completedYou never see the password, the QR code or the one-time code. You get an account id and two webhooks.
The objects
| Object | What it is |
|---|---|
| Connected account | One inbox or profile a user has linked. The unit everything else hangs off, and the unit we bill on. |
| End user | Your own user, identified by your own id. aux0 stores that id and whatever you choose to pass for display. |
| Chat | A conversation: a direct thread, a group or a channel. |
| Message | One message in a chat, with its attachments, reactions and delivery status. |
| Thread / Email | The mail equivalents, across Gmail, Outlook and IMAP. |
| Profile | A person on a social provider, as the connected account can see them. |
| Webhook | Where aux0 posts events, signed and retried. |
Where to start
- Quickstart — a message sent in about fifteen minutes.
- Connected accounts — the object everything else references.
- Hosted auth — how your users link their own accounts.
- Account health — what happens when a session breaks, which it will.
What is live
Gmail, Outlook, iCloud, Fastmail, Zoho and any IMAP server for mail; Google Calendar, Outlook Calendar and CalDAV; Google Contacts, Outlook Contacts and CardDAV. The connector index is the source of truth, and names what is coming without pretending it is here.