Models

Schemas

Activity Log

Activities performed by Admins.

idstring

The id representing the activity.

Example:"6"

performed_byobject

Details about the Admin involved in the activity.

metadataobject or null(Activity Log Metadata)

Additional data provided about Admin activity.

created_atinteger, (date-time)

The time the activity was created.

Example:1671028894

activity_typestring

Enum:"admin_conversation_assignment_limit_change""admin_ticket_assignment_limit_change""admin_avatar_change""admin_away_mode_change""admin_deletion""admin_deprovisioned""admin_impersonation_end""admin_impersonation_start""admin_impersonation_consent_approved""admin_impersonation_consent_revoked"

Example:"app_name_change"

activity_descriptionstring

A sentence or two describing the activity.

Example:"Admin updated the app's name to \"My App\"."

{
  "id": "6",
  "performed_by": {
    "type": "admin",
    "id": "1295",
    "email": "john@example.com",
    "ip": "198.51.100.255"
  },
  "metadata": {
    "sign_in_method": "email_password",
    "external_id": "f3b87a2e09d514c6c2e79b9a",
    "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",
    "conversation_assignment_limit": 15,
    "ticket_assignment_limit": 20,
    "team": { … },
    "team_assignment_limit": 10
  },
  "created_at": 1671028894,
  "activity_type": "app_name_change",
  "activity_description": "Admin updated the app's name to \"My App\"."
}