Description of System Audit API Data Structures

Contents

1. Event Types
   • WorkspaceCreated
   • WorkspaceMemberInvited
   • WorkspaceMemberJoined
   • ChatMemberJoined
   • WorkspaceMemberRoleChanged
   • ChatMessageSent
   • CallStarted
   • AnonymousCallStarted
   • RegistrationEvent
   • LoginAttemptEvent
   • SharedLinkEvent
   • DashboardLoginAttemptEvent
   • DashboardUserSystemAdminRoleChangedEvent
   • DashboardUserOrgAdminRoleChangedEvent
2. Auxiliary Structures
   • ConferenceTarget
   • SharedLinkInfo

---

Event Types

WorkspaceCreated

Workspace creation event.

Example:

{
  "type": "WorkspaceCreated", // Event type
  "timestamp": "2023-05-15T10:00:00Z", // Timestamp
  "sessionId": "2qLBHvJwX3G", // Creator session identifier
  "ip": "192.168.1.1", // Creation IP address
  "workspaceId": "3aKp9RmVbN2", // Workspace identifier
  "creatorId": "5tFgY7hUjK1" // Creator identifier
}

WorkspaceMemberInvited

Event of inviting a member to a workspace.

Example:

{
   "type": "WorkspaceMemberInvited" // Event type,
   "timestamp": "2023-05-15T10:05:00Z" // Timestamp,
   "sessionId": "2qLBHvJwX3G", // Inviter session identifier
   "ip": "192.168.1.1" // IP address,
   "workspaceId": "3aKp9RmVbN2" // Workspace identifier,
   "inviterId": "5tFgY7hUjK1", // Inviter identifier
   "invitedEmails": ["3aKp9RmVbN2", "3aKp9RmVbN2"], // Invited emails
   "role": "MEMBER" // Invited role
}

WorkspaceMemberJoined

Event of a member joining a workspace.

Example:

{
   "type": "WorkspaceMemberJoined" // Event type,
   "timestamp": "2023-05-15T10:10:00Z" // Timestamp,
   "sessionId": "7yNcDpQrS4T", // Joiner session identifier
   "ip": "192.168.1.2" // IP address,
   "workspaceId": "3aKp9RmVbN2" // Workspace identifier,
   "accountId": "8uHbKjMlP9Z", // Member identifier
   "role": "MEMBER" // Member role
}

ChatMemberJoined

Event of adding a member to a chat.

Example:

{
   "type": "ChatMemberJoined" // Event type,
   "timestamp": "2023-05-15T10:15:00Z" // Timestamp,
   "sessionId": "2qLBHvJwX3G", // Initiator session identifier
   "ip": "192.168.1.1" // IP address,
   "workspaceId": "3aKp9RmVbN2" // Workspace identifier,
   "chatId": "3aKp9RmVbN2", // Chat identifier
   "inviterId": "5tFgY7hUjK1", // Inviter identifier
   "invitees": ["8uHbKjMlP9Z", "9vIcLkNoQ0X"], // Added identifiers
   "role": "MEMBER" // Chat role
}

WorkspaceMemberRoleChanged

Event of changing a workspace member's role.

Example:

{
   "type": "WorkspaceMemberRoleChanged" // Event type,
   "timestamp": "2023-05-15T10:20:00Z" // Timestamp,
   "sessionId": "2qLBHvJwX3G", // Initiator session identifier
   "ip": "192.168.1.1" // IP address,
   "workspaceId": "3aKp9RmVbN2" // Workspace identifier,
   "initiator": "5tFgY7hUjK1", // Initiator identifier
   "changed": "8uHbKjMlP9Z", // Member identifier
   "newRole": "ADMIN" // New role
}

ChatMessageSent

Event of sending a message to a chat.

Example:

{
   "type": "ChatMessageSent" // Event type,
   "timestamp": "2023-05-15T10:25:00Z" // Timestamp,
   "workspaceId": "3aKp9RmVbN2" // Workspace identifier,
   "chatId": "3aKp9RmVbN2" // Chat identifier,
   "authorId": "5tFgY7hUjK1" // Author identifier
}

CallStarted

Call start event.

Example:

{
   "type": "CallStarted" // Event type,
   "timestamp": "2023-05-15T10:30:00Z" // Timestamp,
   "workspaceId": "3aKp9RmVbN2" // Workspace identifier,
   "initiatorId": "5tFgY7hUjK1", // Initiator identifier
   "target": {
      "type": "ConferenceTargetChat" // Event type,
      "chatId": "3aKp9RmVbN2" // Chat identifier
   }
}

AnonymousCallStarted

Anonymous call start event.

Example:

{
   "type": "AnonymousCallStarted" // Event type,
   "timestamp": "2023-05-15T10:35:00Z" // Timestamp,
   "workspaceId": "3aKp9RmVbN2" // Workspace identifier,
   "recipientId": "8uHbKjMlP9Z", // Recipient identifier
   "target": {
      "type": "ConferenceTargetWatercooler" // Event type,
      "scope": "PUBLIC", // Visibility scope
      "participantIds": ["3aKp9RmVbN2", "3aKp9RmVbN2"], // Participants
      "initiator": "3aKp9RmVbN2", // Initiator
      "chatId": "3aKp9RmVbN2" // Chat identifier
   }
}

RegistrationEvent

User registration event.

Example:

{
   "type": "RegistrationEvent" // Event type,
   "timestamp": "2023-05-15T10:40:00Z" // Timestamp,
   "accountId": "9vIcLkNoQ0X", // User identifier
   "sessionAppKind": "WEB", // Client type
   "eventType": "MAGIC_LINK", // Authentication method
   "sessionId": "1aMbNcOdPeQ", // Session identifier
   "ip": "192.168.1.3" // IP address
}

LoginAttemptEvent

Login attempt event.

Example:

{
   "type": "LoginAttemptEvent" // Event type,
   "timestamp": "2023-05-15T10:45:00Z" // Timestamp,
   "contact": "user@example.com", // Email or identifier
   "sessionId": "2bNcOdPeQfR", // Session identifier
   "authMethod": "PASSWORD", // Authentication method
   "ip": "192.168.1.4", // IP address
   "result": false, // Result (success/failure)
   "errorMessage": "Invalid password" // Error message
}

SharedLinkEvent

Shared link operation event.

Example:

{
   "type": "SharedLinkEvent" // Event type,
   "timestamp": "2023-05-15T10:50:00Z" // Timestamp,
   "accountId": "5tFgY7hUjK1", // User identifier
   "sessionId": "3cOdPeQfRgS", // Session identifier
   "ip": "192.168.1.5", // IP address
   "sharedLinkId": "4dPeQfRgShT", // Link identifier
   "info": { // Link information
      "type": "WorkspaceInvite" // Event type,
      "workspaceId": "3aKp9RmVbN2", // Workspace identifier
      "creator": "5tFgY7hUjK1", // Creator
      "expiration": "2023-06-15T10:50:00Z" // Expiration date
   },
   "operation": "CREATE" // Operation type
}

DashboardLoginAttemptEvent

Admin panel login attempt event.

Example:

{
   "type": "DashboardLoginAttemptEvent" // Event type,
   "timestamp": "2023-05-15T10:55:00Z" // Timestamp,
   "contact": "admin@example.com", // Email or identifier
   "ip": "192.168.1.6", // IP address
   "result": true, // Result
   "errorMessage": null // Error message
}

DashboardUserSystemAdminRoleChangedEvent

System administrator role change event.

Example:

{
   "type": "DashboardUserSystemAdminRoleChangedEvent" // Event type,
   "timestamp": "2023-05-15T11:00:00Z" // Timestamp,
   "ip": "192.168.1.7", // IP address
   "initiator": "5tFgY7hUjK1", // Initiator
   "changed": "8uHbKjMlP9Z", // Member
   "changeType": "GRANT" // Change type (grant)
}

DashboardUserOrgAdminRoleChangedEvent

Organization administrator role change event.

Example:

{
   "type": "DashboardUserOrgAdminRoleChangedEvent" // Event type,
   "timestamp": "2023-05-15T11:05:00Z" // Timestamp,
   "ip": "192.168.1.8", // IP address
   "initiator": "5tFgY7hUjK1", // Initiator
   "changed": "9vIcLkNoQ0X", // Member
   "organizationId": "6uGxZ8iWaV3", // Organization identifier
   "changeType": "REVOKE" // Change type (revoke)
}

Auxiliary Structures

ConferenceTarget

Base type for conference target.

Examples:

{
  "type": "ConferenceTargetChat", // Target type (chat)
  "chatId": "5tFgY7hUjK1" // Chat identifier
}

{
  "type": "ConferenceTargetWatercooler", // Target type (watercooler)
  "scope": "PUBLIC", // Visibility scope
  "participantIds": ["3aKp9RmVbN2", "3aKp9RmVbN2"], // Participants
  "initiator": "5tFgY7hUjK1", // Initiator
  "chatId": "5tFgY7hUjK1" // Chat identifier
}

SharedLinkInfo

Base type for shared link information.

Examples:

{
  "type": "WorkspaceInvite", // Link type
  "workspaceId": "3aKp9RmVbN2", // Workspace identifier
  "creator": "5tFgY7hUjK1", // Creator
  "expiration": "2023-06-15T10:50:00Z" // Expiration date
}

{
   "type": "FileSharing" // Event type,
   "workspaceId": "3aKp9RmVbN2" // Workspace identifier,
   "fileId": "7yVcXwLzP2K" // File identifier
}