Back to Overview
CORE CONCEPTSAvailable

Actor

An Actor defines a human user or background system participant performing actions in the experience graph.


Definition & Purpose

An Actor represents a participant capable of triggering actions or receiving notifications in the experience graph. Declaring actors makes security permissions and role boundaries explicit.

Actor Classifications

Actors are categorized using the 'type' attribute:

  • human — End user, workspace admin, support agent, or buyer.
  • system — Automated backend service, webhook listener, cron worker, or payment gateway.

Address Syntax & Examples

Actor addresses use the actors top-level dictionary:

YAML
Address format:
actors.actor_id
Real-world domain address examples:
- actors.customer
- actors.workspace_admin
- actors.stripe_billing_system
- actors.auth_service

Complete Valid Example

Here is a document declaring human and system actors:

YAML
actors:
customer:
name: Workspace Owner
type: human
metadata:
role: owner
stripe_gateway:
name: Stripe Payment Webhook
type: system
metadata:
protocol: HTTPS Webhook

What an Actor Does NOT Mean

An Actor is NOT a database user ID, NOT an OAuth access token, and NOT a user profile object. It describes participant roles across the experience graph.