> For the complete documentation index, see [llms.txt](https://academy.vambe.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://academy.vambe.ai/asistentes-ia/asistentes-ia-pt-br/funcoes/como-conectar-tu-asistente-con-sistemas-externos-apis-usando-webhooks.md). # Como conectar seu Assistente com sistemas externos (APIs) usando Webhooks? A função Chamada de Webhook é a ferramenta que permite que sua Inteligência Artificial "converse" com outros sistemas fora da Vambe. Para que serve? Permite enviar ou buscar dados. * Consultar dados (GET): A IA pode ir até o seu sistema, perguntar "Onde está o pedido 123?" e responder ao cliente "Seu pedido foi entregue ontem". * Enviar dados (POST): A IA pode pegar os dados do chat e enviá-los para seu banco de dados ou CRM externo. *** #### ⚠️ Requisito: Conhecimento Técnico Esta função exige lidar com conceitos de programação como APIs, Endpoints, JSON e Métodos HTTP (GET, POST, etc.). Se você não lida com esses termos, recomendamos pedir ajuda à sua equipe de desenvolvimento. *** #### Configuração Passo a Passo: Exemplo "Status do Pedido" Neste exemplo, configuraremos a IA para que, quando um cliente perguntar sobre sua compra, a IA consulte uma API externa e forneça a resposta. **Passo 1: Instrução no Assistente** 1. [Vá para o seu Assistente](/asistentes-ia/asistentes-ia-pt-br/como-montar-os-blocos/como-ingresar-al-asistente-de-inteligencia-artificial.md) e entre em **Casos Possíveis** (ideal para perguntas que podem surgir a qualquer momento). 2. Defina a lógica no texto: *"Quando o cliente precisar saber o status do pedido, peça o número de rastreamento; assim que ele informar, execute a função webhook"*. **Passo 2: Configuração Básica do Webhook** Clique em + Adicionar Função e selecione Chamada de Webhook.
Configure os dados base: 1. **Nome**: Ex: "Status do Pedido". 2. **Descrição (Vital)**: Diga à IA quando usar. Ex: *"Quando o cliente perguntar o status do pedido e você já souber o número do pedido"*. 3. **Método**: Selecione o verbo HTTP (GET, POST, PUT, DELETE). Para consultar dados, usaremos GET. 4. **URL (Endpoint)**: Cole o endereço da sua API.
**Passo 3: Configuração de Parâmetros e Variáveis** É aqui que você conecta os dados. Você tem abas para Body, Headers, Params e Route. **A. Autenticação (Headers)**: Se sua API exigir uma chave (Token), adicione-a em *Headers*. * *Importante:* Se o token for fixo, DESATIVE o interruptor de "Use AI". Isso diz ao sistema que é um valor estático e a IA não deve tentar inventá-lo ou procurá-lo no chat. **B. Variáveis Dinâmicas (A mágica da IA)**: Se você precisar inserir um dado que o cliente informou no chat (como o `order_id`) dentro da URL, use chaves duplas: `{{order_id}}`. * Ao fazer isso, uma aba de Route (ou Params/Body, conforme o caso) será criada automaticamente. * **ATIVE o interruptor "Use AI"**: Isso permite que a IA procure esse número na conversa. * **Descrição do parâmetro:** Escreva o que é (Ex: "O número do pedido"). Assim fica uma configuração correta com variáveis dinâmicas: Observe como o campo `order_id` tem o switch de IA ativado (azul), permitindo que o assistente extraia esse dado do chat. **Passo 4: Verificação Visual (Como deve ficar?)** Antes de testar, confirme que a função foi vinculada corretamente ao passo. Revise a estrutura: Você deve ver o texto da sua instrução e, logo abaixo, um cartão branco dizendo "🔗 Chamada de Webhook" (ou o nome que você deu, como "Informações do Pedido"). * Se você vê o texto, mas NÃO vê o cartão abaixo, a IA lerá a instrução, mas não conseguirá executar nada. Certifique-se de clicar em "Criar"!
*** #### 💡 Outra Alternativa: Webhooks em Workflows Está buscando disparar um Webhook quando ocorre um evento (ex.: entra um cliente novo, muda de etapa ou recebe uma etiqueta) e não necessariamente em uma conversa? Para esses casos de automação pura, não use as funções do Assistente. Você deve usar os Workflows. 👉 [\[Clique aqui para ver o artigo completo sobre Workflows e Automações\]](https://academy.vambe.ai/workflows/workflows-pt-br/) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://academy.vambe.ai/asistentes-ia/asistentes-ia-pt-br/funcoes/como-conectar-tu-asistente-con-sistemas-externos-apis-usando-webhooks.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.