Skip to main content
POST
Send an event

Authorizations

Authorization
string
header
required

API key from your account settings

Path Parameters

agentId
string
required

The agent ID

Minimum string length: 1
Example:

"5QHA6VB-DIAbBhxwqxfdi"

Body

application/json
type
string
required

Event name. A custom. prefix is optional: trial_started and custom.trial_started are the same event.

Pattern: ^[\w.-]{1,100}$
Example:

"trial_started"

subject
object
required

Who the event is about, exactly one of: a person by external_id, email or phone (the contact is created when new), or a mission run by run_id.

properties
object

Fields of the event, at most 8 KB as JSON.

Example:
effect
enum<string>

Required for a run subject, not allowed otherwise: wake the run, add to its context, or end it as succeeded.

Available options:
wake,
context,
end_run
details
string

A short note for a run subject.

Maximum string length: 500
idempotency_key
string

Sending the same key again does nothing.

Required string length: 1 - 200
Example:

"signup-8812"

Response

The event was recorded

id
string<uuid>
required

The event ID