API reference
Events
GET /v0/events, GET /v0/inboxes/{inbox_id}/events and the WebSocket endpoint — parameters, responses and errors.
docs.simail.ai/api/events
Payloads and types: Event types. How to poll reliably: Polling events.
List events
Section titled “List events”GET
/v0/eventsPermission event_read.
| Query parameter | Notes |
|---|---|
after | cursor from next_cursor; omit to start from the oldest retained event |
types | comma-separated event types |
inbox_ids | comma-separated inbox IDs within your scope |
limit | 1–200, default 50 |
200 OK: { "count", "limit", "events": [ … ], "next_cursor" }.
| Status | code | When |
|---|---|---|
| 400 | invalid_request | the cursor belongs to another key scope, organization or filter |
| 403 | missing_permission | no event_read |
| 410 | gone | the cursor is older than the 30-day retention |
Inbox events
Section titled “Inbox events”GET
/v0/inboxes/{inbox_id}/eventsPermission event_read. Same parameters (except inbox_ids) and response, for one inbox.
WebSocket
Section titled “WebSocket”GET
wss://api.simail.ai/v0/wsPermission event_read. Upgrades to a WebSocket. See Realtime.
| Close code | Meaning |
|---|---|
1000 | normal close, including the 1-hour connection lifetime; reconnect |
4401 | the key was revoked or narrowed, or the organization was paused; do not reconnect with this key |