> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notifique.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Introdução

> Quando algo acontece no seu sistema ou num canal, a Notifique executa uma sequência de passos.

<Tip>
  **Automação** é um **roteiro**: quando X acontece, executa passos (enviar, esperar, IA, condição…). **Evento** é o nome do fato. **Execução (run)** é cada vez que o roteiro roda para uma pessoa.
</Tip>

## O que são Automações na Notifique?

É o motor de **jornadas**: você monta um grafo de passos no painel ou pela API. Quando o **gatilho** dispara, nasce uma **run** que percorre envio de template, delay, assistente IA, atualização de contato, etc.

Você pode:

* **Disparar** por evento da sua API (`pedido_pago`, `user.created`)
* **Receber** webhook HTTP de ferramentas externas (Zapier, ERP)
* **Reagir** a mensagem recebida no canal (WhatsApp, SMS, widget…)
* **Consultar** execuções e auditar o que aconteceu

Pense num **roteiro de teatro**: o gatilho levanta a cortina; cada passo é uma cena.

## Não confunda: mapa dos conceitos

| Conceito                 | O que é                                                       |
| ------------------------ | ------------------------------------------------------------- |
| **Automação**            | O fluxo completo (grafo de passos), ligada ou pausada         |
| **Evento**               | Nome cadastrado para um fato do seu sistema (`pedido.pago`)   |
| **Execução (run)**       | Uma corrida do fluxo para um destinatário                     |
| **Gatilho**              | Como o fluxo **começa** (evento, webhook ou mensagem inbound) |
| **Assistente IA**        | “Cérebro” da conversa, instruções + modelo + base + MCP       |
| **Base de conhecimento** | Textos/FAQs que a IA consulta (RAG)                           |
| **MCP**                  | Ferramentas externas para a IA (Gmail, agenda, sua API)       |

**Campanha** (aba Contatos) = disparo em lote **uma vez**. **Automação** = sequência **repetível** quando o gatilho dispara de novo.

<Note>
  **Webhook da automação** (inicia o fluxo) ≠ **webhook da Notifique** (avisa entrega de SMS, status de mensagem, etc.). Veja [Webhooks](/guides/webhooks/index) nos Guias.
</Note>

## Três formas de disparar

| Forma                                                | Quem inicia                   | Exemplo                                |
| ---------------------------------------------------- | ----------------------------- | -------------------------------------- |
| **[Evento](/automations-api/como-funciona/eventos)** | Seu backend via API           | `POST` Enviar evento com `pedido.pago` |
| **Webhook HTTP**                                     | Sistema externo (POST na URL) | Zapier, ClickUp, ERP                   |
| **Mensagem recebida**                                | Cliente no canal              | Chatbot com assistente IA              |

## Passos comuns no grafo

| Tipo                  | O que faz                                    |
| --------------------- | -------------------------------------------- |
| **Gatilho**           | Ponto de partida (um por fluxo)              |
| **Enviar template**   | Mensagem por e-mail, SMS, WhatsApp…          |
| **Esperar (delay)**   | Pausa por tempo                              |
| **Condição**          | Ramo `true` / `false` (os dois obrigatórios) |
| **Assistente IA**     | Resposta com base de conhecimento e/ou MCP   |
| **Atualizar contato** | Tag, campo ou tópico                         |
| **Encerrar**          | Para o ramo                                  |

Status da automação: **ENABLED** (dispara) ou **PAUSED** (não dispara). Parar run ativa: API com `automations:write`.

## O que está na API v1

Rotas com prefixo **`/v1/`** e autenticação por **API Key** (`sk_live_...` / `sk_test_...`):

* **Eventos**, cadastrar e disparar (`events:read`, `events:write`)
* **Automações**, grafos, parar fluxo, listar execuções (`automations:read`, `automations:write`)

Referência completa na spec **Automações e eventos** no menu lateral.

<Info>
  Cada API Key pertence a **um** workspace. Na v1 **não envie** `x-workspace-id`. Use **`Idempotency-Key`** ao disparar evento.
</Info>

## Painel (fora da API v1)

**Base de conhecimento**, **assistentes** e **integrações MCP** configuram-se **no painel** (Automações → Bases, Assistentes, MCP). Não há rotas `/v1/` públicas para isso nesta documentação, use os guias [Assistentes](/automations-api/como-funciona/assistentes), [Base de conhecimento](/automations-api/como-funciona/base-de-conhecimento) e [Integrações MCP](/automations-api/como-funciona/integracoes-mcp).

## Quando usar?

Funciona muito bem para **sequência após evento**, **chatbot** e **follow-up** (esperar + segunda mensagem). Para **envio único** sem repetir, use [template](/template-api/como-funciona/quick-start) ou API do canal.

## Próximos passos

* [Quick Start](/automations-api/como-funciona/quick-start): primeiro evento e fluxo
* [Eventos](/automations-api/como-funciona/eventos): cadastrar e disparar
* [Eventos dos Webhooks](/automations-api/como-funciona/eventos-do-webhooks): runs e status via webhook
* [Assistentes](/automations-api/como-funciona/assistentes): configurar IA
* [Base de conhecimento](/automations-api/como-funciona/base-de-conhecimento) · [Integrações MCP](/automations-api/como-funciona/integracoes-mcp)
* [Casos de uso](/automations-api/como-funciona/casos-de-uso): exemplos prontos
* [Escopos da API Key](/automations-api/como-funciona/escopos-da-api-key)
