ActionModel

A delivery instruction that fires when operator results meet its condition.

type
Type: string · Typeenum
required

webhook posts to your endpoint; whisper synthesises a text operator's output into the audio.
values
- webhook
- whisper
condition
Type: object · ConditionModelnullable

Optional condition narrowing when the action fires. Omit for an unconditional action.

An action condition: a single clause, or a compound of clauses combined with all / any.
- all
  Type: array object[] | null · Allnullable
  
  Compound AND — the action fires only when every clause is met.
- any
  Type: array object[] | null · Anynullable
  
  Compound OR — the action fires when any clause is met.
- expression
  Type: string · Expressionnullable
  
  Single-clause form: the expression to evaluate.
- operator
  Type: string · Operatornullable
  
  Single-clause form: the operator to test.
content
Type: object · Contentnullable

For a whisper action, {"operator": "<text-operator-name>"} — the text operator to voice.
- propertyName
  Type: anything
once_per_session
Type: boolean · Once Per Session

When true, the action fires at most once per session, suppressing later matches.
trigger
Type: string · Trigger

What the action fires on. Only operator_result is currently accepted; lifecycle triggers are reserved and rejected with 422 until supported.
webhook_headers
Type: object · Webhook Headersnullable

Optional headers to send with the webhook, e.g. an auth token.
- propertyName
  Type: anything
webhook_url
Type: string · Webhook Urlnullable

Destination URL for a webhook action.
whisper_channel
Type: string · Whisper Channelenumnullable

For a whisper action, which side of the conversation the synthesised audio is injected into.
values
- caller
- recipient