Trigger: Webhook

Quando usar

Use o Webhook quando quiser que um sistema externo inicie seu workflow. Exemplos comuns:

• Um formulário do seu site envia dados para o Brife


• Outro sistema (ERP, CRM, etc.) notifica o Brife sobre um evento


• Uma integração via Zapier, Make ou n8n dispara uma ação no Brife


• Um script ou aplicação própria faz uma chamada HTTP

---

Como funciona

Ao adicionar este gatilho ao workflow, o Brife gera uma URL única para o seu fluxo. Qualquer requisição HTTP enviada para essa URL inicia uma nova execução do workflow.

A URL segue o formato:

```
https://workflow.brife.com.br/trigger/webhook/{id-do-workflow}
```

---

Configurações

URL do Webhook

Campo somente leitura que exibe a URL gerada para este workflow. Use o botão de copiar ao lado para copiá-la rapidamente.

Autenticação

Define como o Brife valida se a requisição é legítima. Isso protege seu workflow contra chamadas não autorizadas.

| Tipo | Campos | Descrição |
|------|--------|-----------|
| Nenhuma | — | Qualquer requisição é aceita. Use apenas para testes. |
| Bearer Token | Token | A requisição deve incluir o header `Authorization: Bearer `. |
| API Key | Nome do header, Valor | A requisição deve incluir um header personalizado com o valor definido. Ex: `X-API-Key: minha-chave-123`. |
| Basic Auth | Usuário, Senha | A requisição deve incluir o header `Authorization: Basic `. |

Parâmetros (Query)

Define os campos esperados na query string da URL. Cada campo tem:

• Nome — nome do parâmetro (ex: `table`, `action`)


• Tipo — tipo do valor: Texto, Numero, Booleano, Objeto ou Lista

Exemplo: se você adicionar um parâmetro `table` do tipo Texto, o sistema externo deve chamar:

```
https://workflow.brife.com.br/trigger/webhook/{id}?table=clientes
```

Campos do Body

Define os campos esperados no corpo (JSON) da requisição. Mesma estrutura dos parâmetros:

• Nome — nome do campo JSON


• Tipo — tipo do valor esperado

Exemplo: se você definir `nome` (Texto) e `valor` (Numero), o sistema externo deve enviar:

```json
{
"nome": "Produto X",
"valor": 99.90
}
```

Headers Personalizados

Define headers adicionais que você espera na requisição. Útil para identificar a origem da chamada ou passar metadados.

• Nome — nome do header (ex: `X-Source`, `X-Tenant-Id`)

---

Dados de saída

Os nodes seguintes no fluxo podem acessar os dados recebidos pelo webhook:

| Variável | Tipo | Descrição |
|----------|------|-----------|
| `method` | Texto | Método HTTP usado na requisição (GET, POST, PUT, etc.) |
| `body` | Objeto | Conteúdo do corpo da requisição (JSON) |
| `query` | Objeto | Parâmetros da query string |
| `headers` | Objeto | Cabeçalhos da requisição |

Se você definiu campos no Body ou Query, os subcampos ficam disponíveis diretamente. Exemplo: `body.nome`, `query.table`.

---

Dicas

• Sempre configure algum tipo de autenticação em produção para evitar que qualquer pessoa dispare seu workflow.


• Os campos definidos no Body e Query servem como documentação e permitem que nodes seguintes acessem esses dados pelo nome. Se você não definir, os dados ainda chegam, mas ficam dentro de `body` como objeto genérico.


• Você pode testar o webhook usando ferramentas como Postman*, *Insomnia ou `curl`:

```bash
curl -X POST https://workflow.brife.com.br/trigger/webhook/{id} \
-H "Content-Type: application/json" \
-H "Authorization: Bearer seu-token" \
-d '{"nome": "Teste", "valor": 100}'
```