Nodes and channels
Every registered node type and channel action: params, defaults and transitions.
packages/core/src/domain/definition/builtins.ts by pnpm generate. Do not edit it by hand; change the source and regenerate.The engine holds no list of node types or channels: both are registries (docs/ARCHITECTURE.md section 20). GET /v1/schema serves the same catalogue. For examples of each node see Nodes.
Node types
start: Start
Transitions: then; required: then.
No parameters.
end: End
Transitions: none (terminal).
| Param | Type | Required | Default | Constraints |
|---|---|---|---|---|
label | string | no | max length 80 |
wait: Wait
Transitions: then; required: then.
| Param | Type | Required | Default | Constraints |
|---|---|---|---|---|
duration | string | yes | pattern ^(\d+)(m|h|d|bd)$ |
wait_for: Wait for an event
Transitions: reply, reply:email, reply:sms, reply:linkedin, connection_accepted, call_connected, meeting_booked, timeout.
| Param | Type | Required | Default | Constraints |
|---|---|---|---|---|
events | array of "reply", "reply:email", "reply:sms", "reply:linkedin", "connection_accepted", "call_connected", "meeting_booked" | yes | min items 1 | |
timeout | string | no | pattern ^(\d+)(m|h|d|bd)$ |
condition: Condition
Transitions: yes, no; required: yes, no.
| Param | Type | Required | Default | Constraints |
|---|---|---|---|---|
mode | "all", "any" | yes | ||
rules | array of object | yes | min items 1; max items 20 |
task: Task for the sender
Transitions: completed, no_answer.
| Param | Type | Required | Default | Constraints |
|---|---|---|---|---|
kind | string | yes | pattern ^[a-z][a-z0-9_]*$; min length 1; max length 32 | |
title | string | yes | min length 1; max length 200 | |
body | string | no | max length 4000 | |
link | string | no | max length 2000 | |
due | string | yes | pattern ^(\d+)(m|h|d|bd)$ | |
expire | string | no | pattern ^(\d+)(m|h|d|bd)$ | |
connected_outcomes | array of string | no | ["connected"] | |
dialer | boolean | no | false | |
auto_complete | boolean | no | true |
outreach: Outreach
Transitions: sent, skipped, failed.
Params are defined by the channel action; see Channels.
Channels
email: Email
Queue seq_email.
email send: Send an email
Counts as a touch: yes. Transitions: sent, skipped, failed.
| Param | Type | Required | Default | Constraints |
|---|---|---|---|---|
name | string | no | max length 120 | |
subject | string | yes | min length 1; max length 300 | |
body | string | yes | min length 1; max length 100000 | |
format | "text", "html" | no | "text" | |
reply_in_thread | boolean | no | false |
sms: SMS
Queue seq_sms.
sms send: Send a text
Counts as a touch: yes. Transitions: sent, skipped, failed.
| Param | Type | Required | Default | Constraints |
|---|---|---|---|---|
name | string | no | max length 120 | |
body | string | yes | min length 1; max length 1000 |