Overview
Every Raw API endpoint and webhook event.
All endpoints live under one base URL, by channel:
https://console.swarmhit.com/api/v1 LinkedIn
https://console.swarmhit.com/whatsapp/api/v1 WhatsApp
https://console.swarmhit.com/email/api/v1 EmailEvery request carries an API key (X-API-KEY or Authorization: Bearer), except the
health checks; see Authentication. Endpoints are grouped by
channel and resource in the sidebar; each page documents its parameters, request and
response schemas and errors, with code examples. The webhook events are listed with them.
The OpenAPI document is at
https://console.swarmhit.com/openapi.yaml, for
Postman, Insomnia or code generators. For a model, see Raw for AI.
Versioning
What can change, what never does, and what to branch on.
Connect a mailbox POST
IMAP/SMTP with a password (`MAIL`), or Google / Microsoft with your OAuth app's tokens (`GOOGLE_OAUTH`, `OUTLOOK`, with `oauth_app_id`), or a service app's delegated access (no token). Every host you name must be public (400 otherwise). A password login is checked first: a refused one is 401 `errors/invalid_credentials` and nothing is created. The mailbox starts `CONNECTING`; `CREATION_SUCCESS` arrives when the engine has connected it. No history is synced: events start from now. With a client key, connects, reconnects and login checks together are limited to 120 per 10 minutes per client (429 with `retry_after_ms`).