> 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/gatilho/webhook.md).

# Webhook

O módulo **Webhook** ativa um fluxo por meio de um link (URL) que pode ser chamado por qualquer sistema externo — como uma loja virtual, um CRM ou uma automação. Quando esse link é acessado, o Hyperflow ativa o fluxo automaticamente e entrega os dados recebidos para as etapas seguintes, permitindo integrar o Hyperflow Integrações com praticamente qualquer outro sistema.

**📷 Inserir print:** visão geral do módulo Webhook na área de trabalho do fluxo

***

### 🧭 Como acessar

1. No menu lateral, clique em **Gerenciamento de aplicativos**.
2. Em seguida, clique em **Fluxos**.
3. Abra ou crie um fluxo e acesse a área de trabalho do fluxo.
4. No painel de módulos, localize a categoria **Gatilho** (identificada pela cor roxa).
5. Arraste o módulo **Webhook** para a área de trabalho do fluxo.

**📷 Inserir print:** painel de módulos com a categoria Gatilho expandida e o módulo Webhook visível

***

### 🔍 Conhecendo o módulo

Ao clicar duas vezes no módulo na área de trabalho do fluxo, um painel de configuração é aberto na lateral da tela. As opções estão organizadas em seções descritas abaixo.

**📷 Inserir print:** painel de configuração do módulo Webhook aberto

***

#### 🔗 Link do webhook

Assim que você adiciona o módulo, um link único já aparece no topo do painel de configuração, em um campo de somente leitura. É esse link que sistemas externos vão chamar para ativar o fluxo.

{% hint style="warning" %}
O link só passa a funcionar depois que você **publicar o fluxo**. Se alguém tentar usá-lo antes disso, vai receber uma mensagem informando que o webhook não foi encontrado.
{% endhint %}

O link não muda: publicar o fluxo novamente não gera um novo link, então você só precisa configurar o sistema externo uma única vez.

O painel também exibe um exemplo pronto de como chamar o link, que pode ser usado como referência para configurar a integração no sistema externo.

**📷 Inserir print:** campo com o link do webhook e o exemplo de chamada exibido no painel

***

#### 📡 Canal

No campo **Canal**, selecione por qual canal (WhatsApp, Instagram, entre outros) o usuário será ativado quando o link for chamado.

{% hint style="info" %}
Cada módulo Webhook funciona com apenas um canal. Se você precisar ativar usuários em mais de um canal a partir do mesmo link, crie um módulo Webhook para cada canal.
{% endhint %}

**📷 Inserir print:** campo Canal com a lista de canais disponíveis

***

#### 🙋 Identificador do usuário

Depois de escolher o canal, um segundo campo aparece para você informar qual usuário deve ser ativado:

| Campo                                             | O que preencher                                                                                                           |
| ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| Telefone do usuário *(quando o canal é WhatsApp)* | Número de telefone do usuário, com código do país e DDD (ex.: `5511999999999`), ou uma variável que contenha esse número. |
| ID do usuário *(demais canais)*                   | Identificador único do usuário naquele canal, ou uma variável que contenha esse identificador.                            |

Normalmente esse campo é preenchido com uma variável que recebe automaticamente os dados enviados por quem chamou o link (por exemplo, `{{input.body.telefone}}`).

**📷 Inserir print:** campo de identificador do usuário preenchido com uma variável

***

#### 📥 Dados recebidos pelo link

O painel exibe três variáveis que ficam disponíveis automaticamente sempre que o link é chamado, e que podem ser usadas em qualquer campo do módulo:

* `{{input.query}}` — dados enviados na própria URL da chamada.
* `{{input.body}}` — dados enviados no corpo da chamada.
* `{{input.headers}}` — informações extras enviadas junto da chamada.

**📷 Inserir print:** seção do painel mostrando as variáveis de dados recebidos

***

#### 📤 Dados enviados para o fluxo

No campo **Parâmetros**, defina quais informações da chamada externa serão entregues para os próximos módulos do fluxo. Os dados são escritos no formato JSON e podem usar as variáveis citadas acima. Exemplo:

```json
{
  "nome": "{{input.body.nome}}",
  "pedido": "{{input.body.numero_pedido}}"
}
```

Os valores definidos aqui ficam disponíveis como variáveis no restante do fluxo.

**📷 Inserir print:** campo Parâmetros com um exemplo de JSON preenchido

***

#### 🧑‍💼 Permitir envio mesmo com atendente humano

Esta opção é uma chave que vem desativada por padrão.

Quando **ativada**, o fluxo é disparado mesmo que o usuário esteja em atendimento com um agente humano no momento em que o link é chamado.

Quando **desativada**, o fluxo não é disparado para usuários em atendimento humano ativo.

**📷 Inserir print:** chave "Permitir envio mesmo com atendente humano" em destaque

***

### 💡 Caso de uso

**Cenário:** uma loja virtual quer avisar automaticamente o cliente pelo WhatsApp sempre que um pedido for despachado, usando o sistema de vendas que ela já utiliza.

**Configuração:**

1. Adicione o módulo **Webhook** ao fluxo "Aviso de Pedido Despachado".
2. No campo **Canal**, selecione o WhatsApp da loja.
3. No campo **Telefone do usuário**, use a variável `{{input.body.telefone}}`.
4. No campo **Parâmetros**, envie os dados do pedido: `{ "pedido": "{{input.body.numero_pedido}}", "previsao": "{{input.body.previsao_entrega}}" }`.
5. Publique o fluxo e copie o link do webhook exibido no painel.
6. Configure o sistema de vendas da loja para chamar esse link sempre que um pedido for despachado, enviando o telefone do cliente, o número do pedido e a previsão de entrega.

**Resultado:** sempre que um pedido for despachado no sistema de vendas, o cliente recebe automaticamente uma mensagem no WhatsApp com os dados do pedido, sem nenhuma ação manual da equipe.

***

### 📌 Dicas úteis

* O link do webhook já aparece assim que você adiciona o módulo, mas só funciona depois que o fluxo é publicado.
* O link não muda: publicar o fluxo novamente não gera um link novo, então você só precisa configurar o sistema externo uma vez.
* Para o canal WhatsApp, use sempre o número completo, com código do país e DDD (ex.: `5511999999999`).
* Se for necessário ativar mais de um canal a partir do mesmo evento externo, crie um módulo Webhook para cada canal.
* Guarde o link do webhook em local seguro — qualquer sistema que o possua pode ativar o fluxo.

***

### 📝 Resumo

* O módulo **Webhook** ativa um fluxo por meio de um link que pode ser chamado por qualquer sistema externo.
* O link aparece assim que o módulo é adicionado, mas só passa a funcionar depois que o fluxo é publicado — e não muda em publicações seguintes.
* É preciso escolher um **canal** e informar qual usuário será ativado (telefone, no caso do WhatsApp, ou ID do usuário nos demais canais).
* Os dados enviados na chamada externa podem ser repassados para o restante do fluxo pelo campo **Parâmetros**.
* A chave **Permitir envio mesmo com atendente humano** define se o fluxo é disparado mesmo durante um atendimento humano ativo.