> 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/atendimento/oportunidades.md).

# Oportunidades

O módulo **Oportunidades** permite que o seu chatbot interaja com o CRM do Desk durante uma conversa. Com ele, você pode criar novas oportunidades, consultá-las, movê-las entre etapas do funil, atualizá-las ou removê-las — tudo de forma automática, enquanto o atendimento acontece.

***

### 🗂️ 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 **Oportunidades** na lista de módulos disponíveis.

<figure><img src="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2FhqfznRGRA0Ym8hCOsqdH%2Fimage.png?alt=media&amp;token=5f9f8e4c-d6e6-41e6-ba16-e952319c631e" alt=""><figcaption><p>Imagem 1 - Lista de módulos com o item "Oportunidades" destacado.</p></figcaption></figure>

{% hint style="warning" %}
**Pré-requisito:** Para usar este módulo, o seu bot precisa ter uma conexão com o Desk configurada. Caso contrário, o módulo exibirá a mensagem *"Parece que você não tem uma conexão com o Desk"*. Acesse as configurações do bot, conecte o Desk e tente novamente.
{% endhint %}

***

### 🧩 Conhecendo o módulo

Ao adicionar o módulo Oportunidades ao fluxo, um painel de configuração é aberto. Nele, você define **o que o bot deve fazer** com as oportunidades do seu CRM.

#### 🔧 Ação

O primeiro passo é escolher **qual operação** o módulo deve executar. Clique no campo **Ação** e selecione uma das opções:

| Ação                       | O que faz                                                      |
| -------------------------- | -------------------------------------------------------------- |
| **Criar oportunidade**     | Cria um novo registro de oportunidade no funil selecionado     |
| **Listar oportunidades**   | Busca e retorna uma lista de oportunidades com base em filtros |
| **Mover oportunidade**     | Move uma oportunidade existente para outra etapa do funil      |
| **Atualizar oportunidade** | Edita os dados de uma oportunidade existente                   |
| **Remover oportunidade**   | Exclui uma oportunidade do CRM                                 |

<figure><img src="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2FlRYyFyfoht4YNAWZfUoh%2Fimage.png?alt=media&amp;token=25c87739-d498-46bb-bddc-246d6d99950f" alt=""><figcaption><p>Imagem 2 - Campo de seleção de ação com as 5 opções visíveis.</p></figcaption></figure>

#### 🔽 Funil (Pipeline)

Após escolher a ação, selecione o **Funil** no qual a operação será realizada. Clique no campo **Selecionar funil** e escolha um dos funis cadastrados no seu Desk.

{% hint style="info" %}
Os campos e etapas disponíveis nas próximas configurações dependem do funil escolhido aqui. Certifique-se de selecionar o funil correto antes de continuar.
{% endhint %}

***

### ⚙️ Configurações por ação

As opções exibidas mudam conforme a ação selecionada. Veja abaixo o que configurar em cada caso.

***

#### 1️⃣ Criar oportunidade

**🎯 Propósito**

Criar automaticamente uma nova oportunidade no CRM durante a conversa — por exemplo, quando um lead chega pelo chatbot.

**✅ Como fazer na tela**

1. Selecione a ação **Criar oportunidade**.
2. Selecione o **Funil** desejado.
3. Selecione a **Etapa** do funil onde a oportunidade será criada.
4. No campo **Adicionar campos**, escolha quais informações o bot deve preencher na oportunidade (ex.: Título, Responsável, Anexo, campos personalizados do funil).
5. Preencha os valores de cada campo selecionado:
   * **Título** — Nome da oportunidade. Campo obrigatório.
   * **Responsável** — Pessoa responsável pela oportunidade. Você pode selecionar da lista de membros ou, ativando a opção **Usar uma variável ou e-mail do responsável**, inserir diretamente o e-mail ou uma variável do fluxo (ex.: `{{input.email}}`).
   * **Anexo** — Informe o **Nome do arquivo** e a **URL do arquivo** para vincular um documento à oportunidade.
   * **Campos personalizados** — Campos extras configurados no seu funil (texto, data, valor monetário, seleção única, múltipla escolha, etc.).
6. Ative **Adicionar contato à oportunidade** caso queira vincular automaticamente o contato do atendimento à oportunidade criada.
7. Em **Tags**, selecione as etiquetas que devem ser aplicadas à oportunidade.
8. Clique em **Salvar**.

{% hint style="info" %}
Datas devem ser preenchidas no formato **DD/MM/AAAA**. Exemplo: `31/12/2025`.
{% endhint %}

**📌 Resultado esperado**

Uma nova oportunidade é criada no funil e na etapa escolhidos, com todos os dados preenchidos. O fluxo segue para o próximo nó conectado.

<figure><img src="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2FyeisqcXXzIHPI6z6NR6c%2Fimage.png?alt=media&amp;token=6e102161-2186-4e8a-a722-761ea3eccb76" alt=""><figcaption><p>Imagem 3 - Configuração completa da ação "Criar oportunidade" com campos preenchidos.</p></figcaption></figure>

***

#### 2️⃣ Listar oportunidades

**🎯 Propósito**

Consultar oportunidades cadastradas no CRM com base em filtros, retornando os resultados para uso no fluxo (por exemplo, para exibir ao atendente ou tomar decisões).

**✅ Como fazer na tela**

1. Selecione a ação **Listar oportunidades**.
2. Selecione o **Funil** desejado.
3. (Opcional) Selecione a **Etapa** para filtrar apenas as oportunidades de uma etapa específica.
4. Na seção **Filtros**, defina critérios de busca:
   * **Nome ou código** — Digite um nome parcial ou o código da oportunidade para filtrar os resultados.
   * **Responsável** — Filtre por responsável. Ative a opção **Usar uma variável ou e-mail do responsável** para usar um valor dinâmico (ex.: `{{input.email}}`), ou desative para selecionar um membro da lista.
5. Na seção **Paginação**, configure:
   * **Limite** — Quantidade máxima de resultados retornados (padrão: 10).
   * **Página** — Número da página a recuperar (opcional).
6. Clique em **Salvar**.

**📌 Resultado esperado**

O módulo retorna a lista de oportunidades que correspondem aos filtros. Os dados ficam disponíveis como variáveis para os próximos nós do fluxo.

<figure><img src="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2FXQwauzaWChIB91O8C2To%2Fimage.png?alt=media&amp;token=0fff5dd8-56d0-46f2-b1f4-a90098f1706d" alt=""><figcaption><p>Imagem 4 - Configuração da ação "Listar oportunidades" com filtros aplicados.</p></figcaption></figure>

***

#### 3️⃣ Mover oportunidade

**🎯 Propósito**

Mudar uma oportunidade de etapa dentro do funil — por exemplo, avançar automaticamente um lead no funil quando ele responde a uma mensagem.

**✅ Como fazer na tela**

1. Selecione a ação **Mover oportunidade**.
2. Selecione o **Funil** desejado.
3. No campo **ID ou CÓDIGO**, informe o identificador da oportunidade que deve ser movida. Você pode usar uma variável do fluxo (ex.: `{{opportunity.id}}`).
4. Selecione a **Etapa de destino** — onde a oportunidade deve ir após ser movida.
5. Clique em **Salvar**.

**📌 Resultado esperado**

A oportunidade é movida para a nova etapa no CRM. O fluxo continua para o próximo nó.

<figure><img src="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2FD352PxC4UejPmKvrlg87%2Fimage.png?alt=media&amp;token=2d5d1fe8-f2e1-4eda-a3c7-6cd4619de21e" alt=""><figcaption><p>Imagem 5 - Configuração da ação "Mover oportunidade" com ID e etapa de destino preenchidos.</p></figcaption></figure>

***

#### 4️⃣ Atualizar oportunidade

**🎯 Propósito**

Editar os dados de uma oportunidade já existente no CRM — por exemplo, atualizar o título ou o responsável com base em uma resposta do usuário.

**✅ Como fazer na tela**

1. Selecione a ação **Atualizar oportunidade**.
2. Selecione o **Funil** desejado.
3. No campo **ID ou CÓDIGO**, informe o identificador da oportunidade a ser atualizada.
4. (Opcional) Selecione a **Etapa** para indicar em qual etapa a oportunidade está.
5. Em **Adicionar campos**, escolha quais campos devem ser atualizados.
6. Preencha os novos valores de cada campo selecionado (mesmas opções disponíveis na ação Criar).
7. Em **Tags**, selecione as etiquetas que devem ser aplicadas.
8. Clique em **Salvar**.

**📌 Resultado esperado**

Os campos selecionados da oportunidade são atualizados no CRM com os novos valores. O fluxo segue para o próximo nó.

<figure><img src="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2FCqA3BKARXrj5B4mQDooF%2Fimage.png?alt=media&amp;token=91f70fe2-9ee0-4b8b-ade2-02505905d828" alt=""><figcaption><p>Imagem 6 - Configuração da ação "Atualizar oportunidade".</p></figcaption></figure>

***

#### 5️⃣ Remover oportunidade

**🎯 Propósito**

Excluir permanentemente uma oportunidade do CRM durante a execução do fluxo.

**✅ Como fazer na tela**

1. Selecione a ação **Remover oportunidade**.
2. Selecione o **Funil** desejado.
3. No campo **ID ou CÓDIGO**, informe o identificador da oportunidade que deve ser removida.
4. Clique em **Salvar**.

{% hint style="warning" %}
A remoção de uma oportunidade é **permanente** e não pode ser desfeita. Certifique-se de que o ID informado é o correto antes de ativar esse módulo no fluxo.
{% endhint %}

**📌 Resultado esperado**

A oportunidade é removida do CRM. O fluxo segue para o próximo nó conectado.

<figure><img src="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2F4yja2vkCHnT5hQA76hIC%2Fimage.png?alt=media&amp;token=3f78a361-a5c9-4b88-9649-a0dd3022d48b" alt=""><figcaption><p>Imagem 7 - Configuração da ação "Remover oportunidade".</p></figcaption></figure>

***

### 🔀 Saídas do módulo no fluxo

Após a execução, o módulo Oportunidades pode direcionar o fluxo por dois caminhos:

| Saída          | Quando acontece                                                                                      |
| -------------- | ---------------------------------------------------------------------------------------------------- |
| **Próximo**    | A operação foi realizada com sucesso                                                                 |
| **Erro (ERR)** | Ocorreu um problema ao executar a operação (ex.: ID não encontrado, conexão com o Desk indisponível) |

Conecte cada saída ao próximo nó conforme a lógica do seu fluxo — por exemplo, exibir uma mensagem de confirmação após o sucesso, ou uma mensagem de erro caso algo falhe.

<figure><img src="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2FCAALOcUPLGVuR8lYbsnM%2Fimage.png?alt=media&amp;token=823105bb-70e0-4b1a-8932-66879808f4f4" alt=""><figcaption><p>Imagem 8 - Nó Oportunidades no canvas mostrando as duas saídas (Próximo e ERR) conectadas.</p></figcaption></figure>

***

### 💡 Dicas úteis

* **Variáveis no fluxo:** A maioria dos campos de texto aceita variáveis dinâmicas usando a sintaxe `{{nome.da.variavel}}`. Use isso para preencher automaticamente dados coletados durante a conversa.
* **Campos personalizados:** Os campos extras disponíveis na seção de campos dependem da configuração do funil no Desk. Se um campo esperado não aparecer, verifique se ele está cadastrado no funil correto.
* **Paginação na listagem:** Se o seu CRM tiver muitas oportunidades, use os campos **Limite** e **Página** para controlar quantos resultados o bot processa por vez.
* **Responsável por e-mail:** Ao usar a opção de variável para o campo Responsável, certifique-se de que a variável contém um e-mail válido cadastrado no Desk — caso contrário, a operação retornará erro.

***

### 📋 Caso de uso

**Cenário:** Uma empresa de vendas usa um chatbot no WhatsApp para qualificar leads. Quando um potencial cliente responde ao formulário de interesse, o bot cria automaticamente uma oportunidade no CRM e a associa ao vendedor responsável pela região do cliente.

**Configuração principal:**

1. Adicione o módulo **Oportunidades** ao fluxo, após a etapa de coleta de dados do lead.
2. Selecione a ação **Criar oportunidade**.
3. Escolha o funil **Vendas** e a etapa **Novos leads**.
4. Em **Adicionar campos**, selecione **Título**, **Responsável** e campos personalizados como **Região** e **Interesse**.
5. Preencha **Título** com a variável `{{lead.nome}}` e **Responsável** com `{{lead.email_vendedor}}`.
6. Ative **Adicionar contato à oportunidade** para vincular o contato do WhatsApp.
7. Conecte a saída **Próximo** a um nó de mensagem que confirma o recebimento ao lead.
8. Conecte a saída **ERR** a um nó que notifica a equipe sobre a falha.

**Resultado esperado no fluxo:** Ao final da conversa, o lead é automaticamente registrado no CRM como uma nova oportunidade, vinculado ao contato e ao vendedor correto, sem nenhuma ação manual da equipe.

***

### ✅ Resumo

* O módulo **Oportunidades** conecta o chatbot ao CRM do Desk para realizar ações em tempo real durante o atendimento.
* São 5 ações disponíveis: **Criar**, **Listar**, **Mover**, **Atualizar** e **Remover** oportunidades.
* A configuração começa sempre pela seleção do **Funil**, que define quais etapas e campos personalizados estarão disponíveis.
* Campos de texto aceitam **variáveis dinâmicas** do fluxo, permitindo automações personalizadas.
* O módulo possui duas saídas: **Próximo** (sucesso) e **ERR** (erro), que devem ser conectadas a nós diferentes conforme a lógica do fluxo.
