Key concepts

Activity log

Every tracked action in a workspace — templates created or edited, renders started, members invited, billing changes, webhook deliveries and more — is written to an append-only activity log. Entries are never updated or deleted, so the log is a reliable record of what happened and when, even after the thing it describes has since changed or been removed.

Each entry records who (or what) acted, which surface the action came from, whether it succeeded, and action-specific details:

ParamTypeNotes
actionstringA dotted name, e.g. "workspace.member.invited" or "render.created".
sourcedashboard | api | signed-url | webhook | mcp | staff | systemWhich surface produced the entry.
statussuccess | failure
actorLabelstringThe acting user's email, or an API key's public id — never a raw key.
metadataobjectVaries by action, e.g. the template or render it refers to.

You can filter the log by any combination of surface (source), outcome (status), action — matched as a prefix, so "workspace.member" covers every member event — and a date range.

An entry committed by staff (support fixing something on your behalf) is always attributed to source: "staff", regardless of what the underlying action would normally report — so it's always clear when a change in the log wasn't made by anyone on the workspace.

This page covers what the log is and how to read it. For the endpoint itself — request parameters, pagination and the full response shape — see GET /v1/workspace/logs.

Was this page helpful?