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

The webhook payload contains the full user object with the updated status field. When the user has a future "Will Return" / out-of-office entry, the payload also includes willReturn (returnTime, optional reason, optional outOfRoam). See the User schema.

Required scopes: Your app must have user:read scope to receive this event. Add user:read.email to include the user's email address in the payload. Presence fields (status, willReturn) require user:read.status.

Request​

Responses​

Return a 200 status to acknowledge receipt of the event