workflows
Automations: view · Read only
See the institute’s automations (workflows): each one’s trigger or schedule, its nodes, recent runs and per-node results, plus the authoring catalog and the batches, lead campaigns and message templates an automation can reference.
Parameters
Parameters
string
required
The action to run:
list, get, runs, catalog, context, template.string
get / runs: an automation id (from
list).string
runs: one execution id (from
runs) to get its per-node log.string
list: ACTIVE, DRAFT, INACTIVE or ALL (default ALL).
string
list: name filter. context: filter batches/templates/etc. by name.
integer
list / runs: max rows (default 20, max 50).
string
catalog: which part of the contract (default overview). One of:
overview, node_types, queries, triggers, trigger_events, query_keys, all.string
context: one kind; omit for all kinds (capped). One of:
batches, audiences, templates, live_sessions, invites.string
template: which channel the name belongs to. One of:
EMAIL, WHATSAPP.string
template: the template name (from context).
What your AI app is told about this tool
What your AI app is told about this tool
workflows_edit
Automations: draft · Makes changes · Drafts only — nothing goes live until someone publishes it in the admin portal.
Let the connected AI app build automations by conversation — compose the workflow (trigger, queries, emails, WhatsApp, delays, conditions), check it against the builder’s rules and save it as a DRAFT, and create the new email and WhatsApp templates it needs (WhatsApp templates go to Meta for approval). A draft never runs until you open it in the builder and publish it; published automations and existing templates cannot be changed or removed from here. Uses no AI credits.
What keeps it safe: draft-only + additive: every workflow save forces status=DRAFT, which never fires (triggers and the scheduler only run ACTIVE workflows); update/discard refuse anything that is not a DRAFT; the template actions only CREATE new email/WhatsApp templates (unused until an automation references them) and never edit or remove an existing one
Parameters
Parameters
string
required
The action to run:
validate, create_draft, update_draft, discard_draft, create_email_template, create_whatsapp_template, sync_whatsapp_templates.string
update_draft / discard_draft: the DRAFT automation’s id.
object
validate / create_draft / update_draft: the workflow JSON (builder shape, see workflows(catalog)).
string
create_*_template: the template name. Email: any unique name, e.g. ‘welcome_new_learner’. WhatsApp: lowercase letters, digits, underscores.
string
create_email_template: subject line; may contain {{placeholders}}.
string
create_email_template: the HTML body with {{placeholders}}, e.g. {{fullName}}.
object
create_email_template: optional human labels per placeholder, e.g. {“fullName”: “Learner name”} (shown in the builder’s mapping UI).
string
create_whatsapp_template: the message body with {{1}}, {{2}}, … variables.
string
create_whatsapp_template: UTILITY (default) or MARKETING. One of:
UTILITY, MARKETING.string
create_whatsapp_template: Meta language code, default en.
string[]
create_whatsapp_template: one realistic example per {{n}} variable, in order (Meta reviews with these).
string[]
create_whatsapp_template: optional semantic names per variable, e.g. [‘name’, ‘class_time’].
string
create_whatsapp_template: optional short text header (no variables).
create_whatsapp_template: optional footer line.
object[]
create_whatsapp_template: optional buttons (max 3): {type: QUICK_REPLY|URL|PHONE_NUMBER, text, url?, phone_number?}.
boolean
create_whatsapp_template: submit to Meta for approval right away (default true).
What your AI app is told about this tool
What your AI app is told about this tool