API reference
Presence
Your status in every app, and the status of the people you work with.
Every app you're signed in to says you're here with a beat, so you show online (or idle) wherever people see you, in Mirage too. Your status (Online, Idle, Do Not Disturb, Invisible) is Mirage's: setting it here is the same as setting it in Mirage, and everyone who sees you hears it.
A beat lasts 7 minutes, or 30 when it says you're idle; send one every few minutes while someone's using the app, and gone when it closes. These routes are for people in the apps: organization keys and assistants acting for someone get 403.
POST /v1/presence/people gives the status of people who share an organization with you, unless either of you blocked the other in Mirage; anyone else is left out. Invisible reads as offline. Custom statuses stay in Mirage (see Mirage).
Every route below, with its parameters, request and response, errors and samples, is in the API reference.
| Route | What it does |
|---|---|
POST /v1/presence/beat | Says you're here from one of your apps (device: 8 to 40 letters, digits, - and _; idle; gone when the app leaves). Lasts 7 minutes, or 30 idle; answers your status (status, shown, customStatus). At most 20 devices at once (429). People only. |
GET /v1/presence/me | Your status as you show to yourself: what you chose (status: online, idle, dnd, invisible), how it shows (shown) and your custom status. People only. |
PATCH /v1/presence/me | Sets your status (status: online, idle, dnd or invisible), as Mirage's does; everyone who sees you hears it. Custom statuses are set in Mirage. People only. |
POST /v1/presence/people | The status of up to 100 people (userIds, emails: their account's) who share an organisation with you, unless either of you blocked the other in Mirage; others are left out. Invisible reads offline. People only. |