Skip to content
Home/
REST API Reference
/
/
Activity Log Metadata

Activity Log Metadata

Additional data provided about Admin activity.

sign_in_methodstring or null

The way the admin signed in.

Example:"email_password"
external_idstring or null

The unique identifier for the contact which is provided by the Client.

Example:"70"
away_modeboolean or null

The away mode status which is set to true when away and false when returned.

Example:true
away_status_reasonstring or null

The reason the Admin is away.

Example:"😌 On a break"
reassign_conversationsboolean or null

Indicates if conversations should be reassigned while an Admin is away.

Example:false
sourcestring or null

The action that initiated the status change.

Example:"admin update from web - Admin id: 93"
auto_changedstring or null

Indicates if the status was changed automatically or manually.

Example:false
update_byinteger or null

The ID of the Admin who initiated the activity.

Example:93
update_by_namestring or null

The name of the Admin who initiated the activity.

Example:"Joe Example"
previous_statestring or null

The state before the change. idle or occupied for an occupancy change, and null when the Admin had not been classified yet; enabled or disabled for an IP allowlist change.

Example:"idle"
new_statestring or null

The state after the change. idle or occupied for an occupancy change; enabled or disabled for an IP allowlist change.

Example:"occupied"
threshold_minutesinteger or null

The inactivity window, in minutes, used to classify the Admin.

Example:15
last_activity_atinteger or null, (date-time)

The time of the Admin's last recorded activity.

Example:1671028894
autoboolean or null

Indicates the state was derived automatically rather than set by an Admin.

Example:true
setting_typestring or null

The group of workspace settings the change belongs to, for example teammate_occupancy or automatic_away_mode.

Example:"teammate_occupancy"
changesobject or null

The settings altered by the change, keyed by setting name. Only settings whose value actually moved are included, so an unchanged setting is absent rather than present with equal values.

Example:
{
  "occupancy_window_minutes": {
    "before": 15,
    "after": 30
  }
}
{
  "sign_in_method": "email_password",
  "external_id": "70",
  "away_mode": true,
  "away_status_reason": "😌 On a break",
  "reassign_conversations": false,
  "source": "admin update from web - Admin id: 93",
  "auto_changed": false,
  "update_by": 93,
  "update_by_name": "Joe Example",
  "previous_state": "idle",
  "new_state": "occupied",
  "threshold_minutes": 15,
  "last_activity_at": 1671028894,
  "auto": true,
  "setting_type": "teammate_occupancy",
  "changes": {
    "occupancy_window_minutes": { … }
  }
}