Passar para o conteúdo principal

Webhooks: o que são, como funcionam e como usar no Ramper Pipeline

O que são webhooks, suas vantagens, os gatilhos disponíveis no Ramper Pipeline e como configurá-los.

Escrito por Vinicius Poleti

Webhook é uma forma de comunicação entre sistemas que envia informações em tempo real sempre que um evento acontece. Esta funcionalidade está disponível em todos os planos.

Vantagens

Notificações automáticas em tempo real (os dados são enviados assim que o evento acontece); redução de chamadas redundantes (não é preciso "perguntar" ao sistema se houve mudanças); e mais eficiência e sincronização entre sistemas.

Gatilhos disponíveis

Oportunidades: foi adicionada; foi editada; data de fechamento modificada; receita modificada; trocou de etapa; entrou em etapa definida. Tarefas: foi adicionada; foi editada; foi concluída.

Como configurar

  1. Acesse Gerenciar > Integrações > Webhooks.

  2. Clique em Adicionar Webhook.

  3. Selecione o gatilho, defina o título e a URL de destino.

  4. Clique em Avançado para configurar os detalhes.

Formatos de envio suportados: JSON, POST (WWW-Form-Urlencoded), PUT (WWW-Form-Urlencoded) e parâmetros de URL. Por padrão, são enviados os mesmos dados exibidos na documentação da API.

Tipos de campos

Campo do sistema: envia variáveis da entidade escolhida (oportunidade, organização, pessoa) — ex.: "org. - nome" envia o nome da organização. Campo manual (Texto): envia um valor fixo. Campo manual (Área de texto): igual ao anterior, mas para textos longos. Cabeçalho adicional: valor fixo enviado no header da requisição, geralmente para autenticação (token da aplicação de destino).

⚠️ Se a URL de destino retornar erro (status 400, 404, 500 etc.) 5 vezes seguidas, o webhook será automaticamente inativado. Dica: consulte a documentação da API do sistema de destino antes de configurar campos personalizados.

Respondeu à sua pergunta?