Skip to Content

The AuditEvent type of the TypeScript SDK, which accounts.listAudit take or answer.

type AuditEvent = {
  accountId: string | null
  action: string
  actorId: string
  actorName: string | null
  actorType: ('system' | 'account' | 'mailbox' | 'recipient')
  createdAt: number
  detail: Record<string, unknown> | null
  forwardedIp: string | null
  id: string
  ip: string | null
  mailboxId: string | null
  resourceId: string
  resourceType: string
}

Fields

FieldTypeDescription
accountIdstring | nullAccount ID owning the touched resource, or null for system actions
actionstringAction identifier (e.g. 'mailbox.delete', 'domain.update')
actorIdstringIdentifier of the acting API key or credential
actorNamestring | nullResolved name of actor (API key name or mailbox address), or null
actorType('system' | 'account' | 'mailbox' | 'recipient')Actor permission scope: 'system', 'account', 'mailbox', or 'recipient' — the anonymous holder of a forwarding disable link or of a verified-recipient confirmation link, identified by the capability spent rather than a credential (so actorName is always null for it)
createdAtnumberAction timestamp in epoch seconds
detailRecord<string, unknown> | nullSanitized JSON object describing specific property changes, or null
forwardedIpstring | nullForwarded client IP address from proxy header, or null
idstringAudit event ULID (time-ordered, newest first)
ipstring | nullDirect network caller IP address, or null
mailboxIdstring | nullActing mailbox ID for mailbox actors, or null
resourceIdstringTarget resource identifier (ULID or domain name)
resourceTypestringType of resource modified ('account', 'domain', 'mailbox', 'route', 'api_key', 'blocklist')

Used by

MethodWhat it does
accounts.listAuditList account audit trail

On this page