Introduction

An automation is a playbook: when X happens, run steps (send, wait, AI, condition…). An event is the fact name. A run is each time the playbook runs for one person.

What are Automations in Notifique?

The journey engine: you build a step graph in the dashboard or via API. When the trigger fires, a run walks through template sends, delays, AI assistants, contact updates, and more. You can:

Trigger from your API (order.paid, user.created)
Receive HTTP webhooks from external tools (Zapier, ERP)
React to inbound messages (WhatsApp, SMS, widget…)
React to outbound WhatsApp call lifecycle phases (completed, hung up, no answer…)
Inspect runs and audit what happened

Think of a theater script: the trigger raises the curtain; each step is a scene.

Concept map

Concept	What it is
Automation	Full flow (step graph), enabled or paused
Event	Registered name for a system fact (`order.paid`)
Run	One execution of the flow for a recipient
Trigger	How the flow starts (event, webhook, inbound message, or WA call lifecycle)
AI assistant	Conversation “brain”, instructions + model + knowledge + MCP
Knowledge base	Indexed docs the AI queries (RAG)
MCP	External tools for the AI (Gmail, calendar, your API)

Campaign (Contacts tab) = one-shot bulk send. Automation = repeatable sequence whenever the trigger fires again.

Automation webhook (starts the flow) ≠ Notifique webhook (channel delivery status, etc.). See Webhooks in Guides.

Four ways to trigger

Way	Who starts	Example
Event	Your backend via API	`POST` Send event with `order.paid`
HTTP webhook	External system (POST to URL)	Zapier, ClickUp, ERP
Inbound message	Customer on channel	Chatbot with AI assistant
WhatsApp call	Outbound call motor	After `completed` → send SMS; after `hung_up` → retry

`whatsappCall` trigger

In the editor: WhatsApp call. In the graph:

{
  "triggerKind": "whatsappCall",
  "callPhase": "completed",
  "from": null
}

Phases: initiated · answered · completed · hung_up · failed · no_answer · rejected.

completed: audio/speech finished (pairs with webhook whatsapp.call.completed).
hung_up: someone hung up mid-call (pairs with whatsapp.call.hung_up).

Run payload includes callId, to / toE164, status, hangupReason, durationSecs, type, instanceId, direction: OUTBOUND. Idempotent per (automation, callId, callPhase).

`channelInbound` trigger on site chat (WEB_WIDGET)

For site widget automations, use triggerKind: "channelInbound" with channel: "WEB_WIDGET". The sendWebWidget step replies in the same chat and is only allowed with this trigger.

{
  "triggerKind": "channelInbound",
  "channel": "WEB_WIDGET",
  "webWidgetId": null
}

Optional webWidgetId: omit or null = any widget in the workspace.

Schedule condition

In a condition, source Business hours: IANA timezone, weekdays, and HH:mm window. true if “now” is inside the window; false otherwise (useful for after-hours inbound).

{
  "source": "schedule",
  "timezone": "America/Sao_Paulo",
  "daysOfWeek": [1, 2, 3, 4, 5],
  "startTime": "09:00",
  "endTime": "18:00"
}

Common step types

Type	What it does
Trigger	Starting point (one per flow)
Send template	Message via email, SMS, WhatsApp…
Send to widget (`sendWebWidget`)	Reply in site chat (requires `channelInbound` + `WEB_WIDGET` trigger)
Place WhatsApp call (`placeWhatsappCall`)	Dial (speak / play / template)
Group participants (`whatsappGroupParticipants`)	`add` / `remove` (QR line)
Group invite (`whatsappGroupInvite`)	`get` / `revoke` / `regenerate`
Delay	Time pause
Condition	`true` / `false` branches (both required); can use schedule
AI assistant	Reply using knowledge base and/or MCP
Update contact	Tag, field, or topic
End	Stops the branch

Automation status: ENABLED (fires) or DISABLED (does not fire). POST /v1/automations//stop disables the automation (DISABLED) and cancels active runs (QUEUED / RUNNING) — scope automations:write.

What’s in the v1 API

Routes with the /v1/ prefix and API Key auth (sk_live_... / sk_test_...):

Events, register and trigger (events:read, events:write)
Automations, graphs, stop flow, list runs (automations:read, automations:write)

Full reference in the Automations and events spec in the sidebar.

Each API Key belongs to one workspace. In v1 do not send x-workspace-id. Use Idempotency-Key when sending events.

Dashboard (outside v1 API)

Knowledge bases, assistants, and MCP integrations are configured in the dashboard (Automations → Bases, Assistants, MCP). There are no public /v1/ routes for these in this documentation, use Assistants, Knowledge base, and MCP integrations.

When to use?

Great for post-event sequences, chatbots, and follow-ups (wait + second message). For a one-off send without repeating, use templates or the channel API.

Next steps

Quick Start: first event and flow
Events: register and trigger
Webhook events: runs and status via webhook
Assistants: configure AI
Knowledge base · MCP integrations
Use cases
API Key scopes

Automations

Eventos

Automações

Runs

Assistentes

Bases de conhecimento

MCP

HTTP tools

Inbox

What are Automations in Notifique?

Concept map

Four ways to trigger

`whatsappCall` trigger

`channelInbound` trigger on site chat (WEB_WIDGET)

Schedule condition

Common step types

What’s in the v1 API

Dashboard (outside v1 API)

When to use?

Next steps

​What are Automations in Notifique?

​Concept map

​Four ways to trigger

​whatsappCall trigger

​channelInbound trigger on site chat (WEB_WIDGET)

​Schedule condition

​Common step types

​What’s in the v1 API

​Dashboard (outside v1 API)

​When to use?

​Next steps

What are Automations in Notifique?

Concept map

Four ways to trigger

`whatsappCall` trigger

`channelInbound` trigger on site chat (WEB_WIDGET)

Schedule condition

Common step types

What’s in the v1 API

Dashboard (outside v1 API)

When to use?

Next steps