Relay

API reference

The same conversations the inbox uses, over HTTP. Sign in with your AXXES account first: every route below requires a session and is scoped to the organization you are in. A conversation that belongs to another organization is reported as not found rather than forbidden, so an id cannot be probed.

• GET/api/v1/conversations

  Every conversation you are a member of, most recently active first.

  Each item carries the participant list and your own unread count for it.

• POST/api/v1/conversations

  Start a conversation.

  Body takes a type of direct or group, the participant ids, and a name for a group.

• GET/api/v1/conversations/{id}/messages

  The messages in a conversation, oldest first.

  Requires membership of that conversation. A conversation id from another organization is not found, not forbidden.

• POST/api/v1/conversations/{id}/messages

  Send a message.

  Delivered over Pusher to everyone else in the conversation as it happens.

• POST/api/v1/conversations/{id}/read

  Mark a conversation read up to this point.

  Clears your unread count for it and updates your last-read marker.

• POST/api/v1/conversations/{id}/typing

  Publish or clear your typing indicator.

  Ephemeral. Nothing is stored; other members see it live and it expires on its own.