Actor reference

Actor objects describe the Spot Thought identity that performed an action. They appear anywhere the API needs to show who created, updated, or triggered an event. Each actor follows a consistent schema so you can safely hydrate audit streams or UI components across resources.

The actor schema

Actors always include the discriminator, identifier, and human friendly name. Use the _type to branch on the kind of identity involved in an operation.

  • Name
    _type
    Type
    string
    Description

    Discriminator that identifies the actor subtype. Valid values are listed below.

  • Name
    id
    Type
    string
    Description

    Unique identifier for the actor.

  • Name
    name
    Type
    string
    Description

    Human readable name associated with the actor.

Example

{
  "_type": "TenantUserActor",
  "id": "user_789",
  "name": "Alex Lee"
}

Actor subtypes

Every actor shares the same shape, but the _type helps you understand the underlying identity:

  • TenantUserActor – Workspace member who performed the action through the Spot Thought console.
  • ParticipantActor – Participant identity the API used to represent an end user in screener responses.
  • TenantActor – Represents your Spot Thought tenant as a whole when service automations take place.
  • ApplicationActor – Denotes access via API keys or OAuth clients within your organization.
  • SystemActor – Internal Spot Thought automation that performed system maintenance.

Use the discriminator to tailor audit logs or filter out automated actions. When a new subtype is introduced, it will be added to this reference so linked resources automatically stay up to date.

Was this page helpful?