Send a presence heartbeat

POST

/v1/presence

const url = 'https://app.mondochat.io/v1/presence';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://app.mondochat.io/v1/presence \
  --header 'Authorization: Bearer <token>'

Keeps the caller online. The chat sends it when it opens and every 25 seconds while it is open and visible. The first heartbeat of an offline user marks them online and tells the peers allowed to see presence; later ones only move last_seen_at, at most one write per 20 seconds. A user with no heartbeat for 60 seconds goes offline. Nothing happens while presence.enabled is off. Needs a session token.

Guide: Presence.

Authorizations

session

Responses

204

Successful Response

4XX

Problem

application/problem+json

An RFC 9457 problem: the body of every error answer.

object

code

required

The stable error code to branch on, such as policy_denied.

string

detail

What went wrong this time, when there is more to say.

string | null

errors

For validation, one entry per invalid field.

Array<object>

One invalid field.

object

loc

The path to the field.

array

msg

What is wrong with it.

string

instance

The path of the request.

string

reason

For policy_denied and limit_reached, the rule or limit that refused the request; for forbidden, a short cause such as you_blocked; for banned, temporary when the ban expires.

string

status

required

The HTTP status code.

integer

title

required

A short summary of the problem.

string

type

required

A URL that names the problem, https://app.mondochat.io/problems/<code>.

string

Example

{
  "code": "policy_denied",
  "detail": null,
  "instance": "/v1/conversations/0199d6a0-2000-7000-8000-000000000001",
  "reason": "pins",
  "status": 403,
  "title": "Policy denied",
  "type": "https://app.mondochat.io/problems/policy_denied"
}