Conecta-seEntrar na plataforma

Webhook

Receber eventos de qualquer serviço por meio de um webhook configurável.

Gatilhos de inícioRecurso internoConexão: Credencial protegida

O que faz

Receba chamadas de qualquer serviço por um webhook próprio.

Quando usar: Use quando o seu fluxo precisar receber eventos de qualquer serviço por meio de um webhook configurável.

Exemplo de situação: Processar os dados antes de seguir para a próxima etapa.

Trate todo conteúdo recebido como dado não confiável. Valide assinatura, origem e formato antes de executar ações com efeito externo.

Antes de começar

Conexão necessária: Credencial protegida.

Escolha uma conexão ou credencial já cadastrada no workspace. Nunca cole senhas ou chaves em campos de texto comuns.

Passo a passo

  1. Adicione Webhook ao desenho a partir da seção Gatilhos da aba Blocos.
  2. Escolha uma conexão ou credencial já cadastrada no workspace. Nunca cole senhas ou chaves em campos de texto comuns.
  3. Revise a ação principal descrita no cartão do bloco.
  4. Preencha os campos obrigatórios. Para usar um dado de uma etapa anterior, digite < e escolha o bloco e o campo.
  5. Clique em Executar com dados de teste e confira, no terminal, o que entrou e o que saiu do bloco.
  6. Só publique depois de conferir o resultado da execução de teste.

Para configurar o gatilho

  1. Copie a URL do webhook e use-a no seu serviço externo ou na sua API.
  2. Configure o seu serviço para enviar webhooks para esta URL.
  3. O webhook aceita POST. Ative "Aceitar outros métodos HTTP" para aceitar também GET, PUT, PATCH e DELETE — por exemplo, para disparar o fluxo a partir de um link em um e-mail.
  4. Os campos do corpo ficam disponíveis no seu fluxo, e os parâmetros de consulta da URL ficam em "query" (por exemplo, "query.id"). Ative "Expor cabeçalhos da requisição" para receber também "headers" (por exemplo, "headers.x-event-name"), e "Aceitar outros métodos HTTP" para receber também "method".
  5. A autenticação é feita por cabeçalho, então não funciona com um link simples. Se a autenticação estiver ativada, envie o token no cabeçalho definido em "Nome do cabeçalho secreto" ou, se você deixou esse campo em branco, em "Authorization: Bearer TOKEN" — só o formato configurado é aceito, não qualquer um dos dois.
  6. Para eliminar eventos duplicados, defina no "Campo de deduplicação" o caminho, em notação de ponto, de um identificador único nos dados do evento (ex.: "event.id"). Valores repetidos dentro de 7 dias serão ignorados.
  7. Ative "Verificar eventos de teste" só se o serviço que envia precisar de uma resposta 200 temporária enquanto valida a URL do webhook.

Campos

  • URL do webhook

    Modo gatilho

    A URL do webhook será gerada.

    Exemplo:
    https://api.exemplo.com/v1/recurso

  • Exigir autenticação

    Modo gatilho

    Exige autenticação em todas as chamadas do webhook.

    Padrão:
    true

  • Token de autenticação

    Modo gatilhoDado protegido

    Token usado para autenticar as chamadas via Bearer token ou cabeçalho personalizado.

    Padrão:
    Segredo protegido

  • Nome do cabeçalho secreto (opcional)

    Modo gatilhoDado protegido

    Nome do cabeçalho HTTP para o token. Se vazio, usa "Authorization: Bearer TOKEN".

    Padrão:
    Segredo protegido

  • Aceitar outros métodos HTTP

    Modo gatilho

    Aceita também GET, PUT, PATCH e DELETE (nenhum outro) e expõe o método em "method". Deixe desligado a menos que precise.

    Padrão:
    false

  • Expor cabeçalhos da requisição

    Modo gatilho

    Disponibiliza os cabeçalhos da requisição em "headers". Cabeçalhos com credenciais são omitidos. Deixe desligado a menos que precise.

    Padrão:
    false

  • Campo de deduplicação (opcional)

    Modo gatilho

    Caminho (notação com ponto) de um campo único no payload. Se o mesmo valor aparecer de novo em 7 dias, a duplicata é ignorada.

    Exemplo:
    event.id

  • Resposta de confirmação

    Modo gatilho

    Escolhe uma das opções aceitas por este campo.

    Opções:
    Padrão · Personalizada
    Padrão:
    Padrão

  • Verificar eventos de teste

    Modo gatilho

    Responde 200 temporariamente a sondagens de teste ou verificação nesta URL durante a configuração.

    Padrão:
    false

  • Código de status da resposta

    Modo gatilho

    Código HTTP (100–599) devolvido a quem chama o webhook. Padrão 200 se vazio ou inválido.

    Quando aparece:
    Quando o campo “Resposta de confirmação” for “Personalizada”
    Exemplo:
    200 (padrão)

  • Corpo da resposta

    Modo gatilho

    Corpo JSON devolvido a quem chama o webhook. Deixe vazio para não enviar corpo.

    Quando aparece:
    Quando o campo “Resposta de confirmação” for “Personalizada”
    Exemplo:
    {"ok": true}

  • Campos de entrada

    Modo gatilho

    Defina o esquema JSON esperado (opcional). Use o tipo "file[]" para uploads de arquivo.

    Exemplo:
    { "chave": "valor" }

Saídas

Este bloco não declara campos de saída separados.

Exemplo de uso

Objetivo: Processar os dados antes de seguir para a próxima etapa.

Webhookprocessamentoação final
URL do webhook
https://api.exemplo.com/v1/recurso
Exigir autenticação
true
Aceitar outros métodos HTTP
false
Expor cabeçalhos da requisição
false
Campo de deduplicação (opcional)
event.id
Resposta de confirmação
Padrão

Os valores são ilustrativos. Teste primeiro com dados fictícios ou de homologação.

Erros comuns e como resolver

O bloco não executa
Confira se existe um caminho de setas que parte do gatilho (ou do Início) até este bloco. Blocos soltos no desenho são ignorados.
Aparece “Validação do fluxo” no terminal
Há campo obrigatório vazio. Clique no aviso, abra o bloco indicado e preencha o campo marcado.
Um campo chega vazio na etapa seguinte
Confira se a referência aponta para um bloco que já executou e para um campo que existe, como <webhook.campo>. O nome antes do ponto é o nome do bloco no seu fluxo, em minúsculas, sem espaços e sem acentos.
Credencial ausente ou recusada
Escolha uma conexão válida do workspace. Se a senha ou a chave mudou no serviço, atualize a conexão cadastrada em vez de colar o segredo no bloco.
O fluxo não inicia sozinho
Gatilhos só disparam com a automação publicada. Confira também se o evento aconteceu na conta conectada e se os filtros do gatilho não estão excluindo o evento.

Blocos relacionados