Interface ActivityInterface

Activity row — append-only audit entry.

Each row is a snapshot of a meaningful change to a user/org-scoped resource. The full pre/post-image of the source document lives on payload. Producers write one row per qualifying mutation; the unique event_id ensures idempotency across multiple relay processes tailing the same change stream.

interface ActivityInterface {
    active?: boolean;
    external_id?: string;
    extensors?: { [key: string]: string };
    record_history?: RecordHistory;
    id?: string;
    user?: string | { id?: string; [key: string]: any };
    org?: string | { id?: string; [key: string]: any };
    resource?: ActivityResource;
    resource_id?: string;
    operation?: ActivityOperation;
    payload?: null | Record<string, any>;
    event_id?: string;
}

Hierarchy (View Summary)

Properties

active? external_id? extensors? record_history? id? user? org? resource? resource_id? operation? payload? event_id?

Properties

Optionalactive

active?: boolean

Whether the entity is active

Optionalexternal_id

external_id?: string

External system identifier for integration with third-party systems

Optionalextensors

extensors?: { [key: string]: string }

Extended properties for custom integrations

Optionalrecord_history

record_history?: RecordHistory

Record history tracking information

Optionalid

id?: string

Unique identifier for the entity

Optionaluser

user?: string | { id?: string; [key: string]: any }

Owner user reference (required if org is not set)

Optionalorg

org?: string | { id?: string; [key: string]: any }

Owner org reference (required if user is not set)

Optionalresource

resource?: ActivityResource

Normalized resource name (e.g. 'plan', 'task', 'drive_item')

Optionalresource_id

resource_id?: string

ID of the source document that changed

Optionaloperation

operation?: ActivityOperation

CRUD verb

Optionalpayload

payload?: null | Record<string, any>

Snapshot of the source document at the time of the change

Optionalevent_id

event_id?: string

Stringified change-stream resume token used as a dedupe key

Settings

Member Visibility

On This Page

Properties