# AuditEvent

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

```ts
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

| Field | Type | Description |
| --- | --- | --- |
| `accountId` | `string` \| `null` | Account ID owning the touched resource, or null for system actions |
| `action` | `string` | Action identifier (e.g. 'mailbox.delete', 'domain.update') |
| `actorId` | `string` | Identifier of the acting API key or credential |
| `actorName` | `string` \| `null` | Resolved 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) |
| `createdAt` | `number` | Action timestamp in epoch seconds |
| `detail` | `Record<string, unknown> \| null` | Sanitized JSON object describing specific property changes, or null |
| `forwardedIp` | `string` \| `null` | Forwarded client IP address from proxy header, or null |
| `id` | `string` | Audit event ULID (time-ordered, newest first) |
| `ip` | `string` \| `null` | Direct network caller IP address, or null |
| `mailboxId` | `string` \| `null` | Acting mailbox ID for mailbox actors, or null |
| `resourceId` | `string` | Target resource identifier (ULID or domain name) |
| `resourceType` | `string` | Type of resource modified ('account', 'domain', 'mailbox', 'route', 'api_key', 'blocklist') |

## Used by

| Method | What it does |
| --- | --- |
| [`accounts.listAudit`](/docs/sdks/typescript/accounts/list-audit) | List account audit trail |
