> For the complete documentation index, see [llms.txt](https://help.hyperflow.global/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.hyperflow.global/docs/builder-hyperflow/gerenciamento-de-aplicativos/fluxos/integracao/aws-sqs.md). # AWS SQS ## 📨 Módulo AWS SQS O módulo **AWS SQS** permite que o seu chatbot envie mensagens a uma fila do Amazon Simple Queue Service (SQS) durante uma conversa. Você pode enviar uma única mensagem ou um lote de mensagens em uma só execução — tudo configurado dentro do fluxo, sem ferramentas externas. **📷 Inserir print:** visão geral do nó AWS SQS no canvas do Builder *** ### 🗂️ Como acessar 1. No menu lateral, clique em **Aplicativo**. 2. Em seguida, clique em **Fluxos**. 3. Abra o fluxo desejado ou crie um novo. 4. No canvas do Builder, clique no botão **+** para adicionar um novo nó. 5. Localize e selecione **AWS - SQS** na lista de módulos disponíveis. **📷 Inserir print:** lista de módulos com o item "AWS - SQS" destacado {% hint style="warning" %} **Pré-requisito:** Para usar este módulo, é necessário ter uma integração com a AWS configurada na plataforma. Caso o campo **Nome da integração** esteja vazio, acesse as configurações de integrações, cadastre as credenciais da AWS (região, chave de acesso e chave secreta) e retorne para configurar o módulo. {% endhint %} *** ### 🧩 Conhecendo o módulo Ao adicionar o módulo ao fluxo, um painel de configuração é aberto. Nele, você seleciona a integração AWS, informa a URL da fila SQS e define o conteúdo da mensagem no formato JSON. O módulo detecta automaticamente se o conteúdo é um único objeto (envia uma mensagem) ou uma lista de objetos (envia em lote). **📷 Inserir print:** painel de configuração do módulo AWS SQS aberto *** ### 🔧 Configurações do módulo #### 📌 Campos do painel de configuração | Campo | O que preencher | | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Nome da integração** | Selecione a integração AWS cadastrada que o bot deve usar para acessar a fila SQS. Campo obrigatório. | | **URL da fila SQS** | Informe o endereço completo da fila SQS de destino. Aceita variáveis do fluxo (ex.: `{{env.SQS_URL}}`). Campo obrigatório. | | **Corpo** | Escreva o conteúdo da mensagem em formato JSON. Para enviar uma única mensagem, use um objeto JSON. Para enviar em lote, use uma lista de objetos JSON. Aceita variáveis do fluxo. Campo obrigatório. | **📷 Inserir print:** painel de configuração com os campos de integração, URL da fila e corpo preenchidos *** ### ⚙️ Recursos do módulo #### 1️⃣ Enviar uma mensagem única **🎯 Propósito** Publicar uma mensagem individual na fila SQS com o conteúdo definido no campo **Corpo**. **✅ Como fazer na tela** 1. Selecione a **integração AWS** no primeiro campo. 2. No campo **URL da fila SQS**, informe o endereço da fila de destino. 3. No editor **Corpo**, escreva um objeto JSON com os dados que deseja enviar. Exemplo: ```json { "protocolo": "{{input.numeroProtocolo}}", "cliente": "{{input.nomeCliente}}", "status": "pendente" } ``` 4. Clique em **Salvar alterações**. **📷 Inserir print:** editor de corpo com um objeto JSON preenchido e variáveis do fluxo inseridas **📌 Resultado esperado** Ao executar o fluxo, o módulo envia a mensagem para a fila SQS e encaminha o fluxo pela saída **Sucesso**. O objeto JSON é publicado com os valores reais das variáveis substituídos no momento do envio. *** #### 2️⃣ Enviar mensagens em lote **🎯 Propósito** Publicar múltiplas mensagens de uma só vez na fila SQS, reduzindo o número de chamadas necessárias. **✅ Como fazer na tela** 1. Selecione a **integração AWS** e informe a **URL da fila SQS**. 2. No editor **Corpo**, escreva uma lista (array) JSON com os objetos que deseja enviar. Exemplo: ```json [ { "id": "1", "evento": "cadastro" }, { "id": "2", "evento": "atualizacao" } ] ``` 3. Clique em **Salvar alterações**. {% hint style="info" %} O módulo detecta automaticamente se o conteúdo do **Corpo** é um objeto único ou uma lista. Se for uma lista, todas as mensagens são enviadas em lote de forma automática — você não precisa configurar nada extra. {% endhint %} **📷 Inserir print:** editor de corpo com uma lista JSON contendo múltiplos objetos **📌 Resultado esperado** Todas as mensagens da lista são publicadas na fila SQS em uma única operação. O fluxo segue pela saída **Sucesso** após o envio ser concluído. *** #### 3️⃣ Usar variáveis do fluxo nos campos **🎯 Propósito** Personalizar a URL da fila e o conteúdo da mensagem com dados dinâmicos coletados durante a conversa ou definidos como variáveis de ambiente. **✅ Como fazer na tela** 1. Em qualquer campo de texto (URL da fila SQS ou Corpo), posicione o cursor onde deseja inserir a variável. 2. Digite `{{` para abrir o seletor de variáveis e escolha a variável desejada, ou escreva o caminho completo manualmente (ex.: `{{input.emailCliente}}`, `{{env.SQS_URL}}`). 3. As variáveis podem ser usadas dentro do JSON do **Corpo** como valores de propriedades. **📷 Inserir print:** editor de corpo com variáveis do fluxo inseridas dentro do JSON **📌 Resultado esperado** No momento em que o fluxo executa o módulo, cada variável é substituída pelo valor real correspondente. A mensagem enviada à fila SQS conterá os dados reais da conversa. *** ### 🔀 Saídas do módulo no fluxo O módulo AWS SQS possui duas saídas que permitem tratar o resultado do envio: | Saída | Quando acontece | | ----------- | --------------------------------------------------------------------------------------------------------------------------- | | **Sucesso** | Ativada quando a mensagem (ou lote) é enviada com sucesso para a fila SQS. | | **Erro** | Ativada quando ocorre uma falha no envio — por exemplo, credenciais inválidas, URL incorreta ou corpo com formato inválido. | {% hint style="warning" %} Sempre conecte a saída **Erro** a um nó de tratamento (como uma mensagem ao usuário ou um registro de log). Isso evita que o fluxo seja interrompido silenciosamente em caso de falha no envio. {% endhint %} **📷 Inserir print:** nó AWS SQS no canvas com as saídas "Sucesso" e "Erro" conectadas a nós subsequentes *** ### 💡 Dicas úteis * **Formato obrigatório:** O campo **Corpo** aceita apenas JSON válido. Verifique que o conteúdo está corretamente formatado antes de salvar — um JSON inválido ativará a saída **Erro** na execução. * **Modo de envio automático:** O módulo detecta sozinho se o corpo é objeto (mensagem única) ou lista (lote). Não há nenhuma chave ou configuração extra para isso. * **Variáveis de ambiente:** Use `{{env.SQS_URL}}` no campo **URL da fila SQS** para evitar fixar o endereço no fluxo. Assim, você pode apontar para filas diferentes em ambientes de teste e produção sem alterar o nó. * **Execução de teste:** Use o botão **Executar nó** no painel de configuração para testar o envio com dados reais antes de publicar o fluxo. * **Integração obrigatória:** Sem uma integração AWS configurada e selecionada, o módulo não consegue se autenticar e o fluxo seguirá pela saída **Erro**. *** ### 📋 Caso de uso **Cenário:** Uma empresa de e-commerce usa um chatbot para processar pedidos. Ao final de cada conversa em que um cliente confirma uma compra, o bot publica automaticamente os dados do pedido em uma fila SQS para que o sistema de processamento de pedidos consuma e registre a venda. **Configuração principal:** 1. **Adicionar o módulo ao fluxo:** * No fluxo de confirmação de compra, após o nó que coleta a confirmação do cliente, adicione o módulo **AWS SQS**. * Selecione a **integração AWS** configurada na plataforma. 2. **Informar a URL da fila:** * No campo **URL da fila SQS**, insira o endereço da fila: `{{env.SQS_URL_PEDIDOS}}`. 3. **Escrever o corpo da mensagem:** * No editor **Corpo**, escreva o JSON com os dados do pedido: ```json { "pedidoId": "{{input.numeroPedido}}", "cliente": "{{input.nomeCliente}}", "email": "{{input.emailCliente}}", "produto": "{{input.produtoSelecionado}}", "valor": "{{input.valorTotal}}", "dataHora": "{{input.dataConfirmacao}}" } ``` 4. **Conectar as saídas:** * Conecte a saída **Sucesso** ao nó que exibe a mensagem de confirmação para o cliente. * Conecte a saída **Erro** ao nó que exibe uma mensagem de falha e orienta o cliente a tentar novamente. **Resultado esperado no fluxo:** A cada confirmação de compra, o bot publica automaticamente os dados do pedido na fila SQS. O sistema de processamento consome a fila e registra a venda sem nenhuma intervenção manual da equipe. *** ### ✅ Resumo * O módulo **AWS SQS** permite publicar mensagens em uma fila do Amazon SQS diretamente dentro de fluxos de chatbot. * O campo **Corpo** aceita JSON: um objeto para mensagem única ou uma lista de objetos para envio em lote — a detecção é automática. * Todos os campos aceitam **variáveis do fluxo** com a sintaxe `{{nome.da.variavel}}`, permitindo mensagens dinâmicas com dados da conversa. * O módulo possui duas saídas: **Sucesso** (mensagem enviada com êxito) e **Erro** (falha no envio) — conecte ambas para garantir um fluxo robusto. * É obrigatório ter uma **integração AWS** configurada na plataforma com região, chave de acesso e chave secreta válidas. --- # 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://help.hyperflow.global/docs/builder-hyperflow/gerenciamento-de-aplicativos/fluxos/integracao/aws-sqs.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.