Skip to main content

User status update

Webhook

A user's presence status has changed (checked in or checked out of the Roam).

Event name: user.status.update

Delivered inside the standard event envelope; the schema below shows the full delivery body with this event's payload under data.

The event payload (data) is the user object with the updated status field (checkedIn or checkedOut). id, name, and status are always present; email requires the user:read.email scope.

Required scope: user:read.status (subscribe and delivery both require this exact scope — user:read alone is not enough). Add user:read.email to include the user's email address in the payload.

Request​

Responses​

Return a 200 status to acknowledge receipt of the event