Skip to main content
POST
Logs one entry, or a batch of up to 1000, to a record’s activity timeline. Use this to keep your own integrations honest with the same trail Clustr’s own actions and Workflows write to. Send either a single item’s fields at the top level, or { "items": [...] } for a batch.

Authorizations

Authorization
string
header
required

The API key you created on the API settings page of the Clustr app.

Body

application/json

One activity (its fields at the top level) or many (items, which wins); at most 1000.

entity
string

account, person or path.

record_key
string
kind
string
actor
string

Omitted: the request's user, or system.

detail
object

What happened, as the activity's kind records it (an owner change carries the old and new owner, a note its text). It is open because each kind has its own fields; it is stored and read back as sent.

items
object[]

Response

Typed result envelope.

success
boolean
required
data
object
required