GET /api/v1/webhook-events (scope events:read), which returns each entry’s entity, eventType, rollout phase, requiredScope, and redaction mode.
Two redaction modes apply on the read path:
- payload-allowed — payload and diff are returned after deep sensitive-field redaction (any string field may surface as
"[REDACTED]"). - ids-only — payload and diff are stripped entirely; you get identifiers, the event type, and
relatedIds, and fetch details from the scoped resource endpoints.
events:read plus the event’s required scope below.
Wakeup event
Documents & folders — documents:read
Cases & matters — cases:read
Intake — intake:read
Tasks — tasks:read
Calendar — calendar:read
Calendar events are currently emitted as one aggregate event per sync batch rather than per item.
Notes — notes:read
Note payloads carry identifiers and the note title only — never the note body.
Deadlines — deadlines:read
E-sign — esign:read
Communications — communications:read
Billing — billing:read
Settlement funds — funds:read
Reports & exports — reports:read
Export-job payloads carry job identity and outcome metadata only (entity, status, row count, byte size) — never row data or storage keys.