O Webhook é a funcionalidade da API que possibilita a automatização do envio de dados e atividades de contatos do RD Station Marketing para sistemas externos. Assim, é possível que você utilize o seu próprio aplicativo personalizado para ler, salvar e realizar ações com esses dados. Esta é uma opção poderosa que permite manter todos os seus dados em sincronia e abre a possibilidade para todos os tipos de integração.
Sempre que o evento configurado como gatilho no Webhook é acionado, o RD Station Marketing faz o envio de um Lead para integrações externas ele faz o disparo de um payload padrão em JSON ("pacote de dados") único e imutável para a URL de destino, que vai vai conter todas as informações disponíveis no Perfil do Lead, o que inclui todos os campos padrão e personalizados que foram preenchidos pelo Lead, bem como, a Origem do Lead. Confira todas as informações enviadas aqui.
Eventos que acionam o envio dos Webhooks
O evento que vai acionar o envio do payload pode ser:
- Conversão: envia os leads que realizaram alguma conversão no RD Station Marketing. Você pode selecionar quais serão essas conversões ou deixar em branco. Neste caso, todo lead que realizar uma conversão será enviado. Se as conversões forem realizadas em uma Landing Page, Formulário ou Pop-up do RD Station Marketing, o identificador vai ser o título da página/nome do elemento criado; se for integrado (formulários integrados, API, etc), eles podem ser identificados pelo identificador da conversão;
- Oportunidade: envia os leads marcados como Oportunidade (estrelinha). Exemplo: enviar o lead do RD Station Marketing para a ferramenta apenas quando ele for marcado como oportunidade manualmente, por integração ou por um fluxo de automação.
O tipo de evento que aciona a solicitação de webhook é definido pelo campo "entity_type".
Atualmente somente "WEBHOOK.CONVERTED" ou "WEBHOOK.MARKED_OPPORTUNITY" são suportados.
Requisitos para funcionamento dos Webhooks
Os Webhooks criados devem obedecer aos seguintes requisitos:
- Ser capaz de receber e consumir dados em formato JSON;
- Possuir certificado de segurança;
- Ter compatibilidade para fazer a leitura do pacote de dados que o RD Station envia.
Importações e atualizações manuais do contato não acionam os Webhooks.
Gestão de Webhooks
Nesta documentação, mostramos como fazer a gestão dos Webhooks da API 2.0: