Documentação API RD Station

Como utilizar a documentação API da TheMembers

Saída: esta integração envia dados de leads do RD Station para uma ferramenta destino, especificada na configuração.
 

O que esta integração faz?

Esta configuração permite enviar dados de leads do RD Station para outras ferramentas que disponham de uma URL de entrada de dados. Essa URL precisa conseguir ler e consumir dados enviados em formato JSON.
 

Observações e requisitos:

• Possuir a URL do outro sistema, que vai receber dados em formato JSON;
• Em caso de URLs personalizadas, é importante ter um desenvolvedor ou contato com o suporte do seu outro sistema para checar a compatibilidade com a leitura do pacote de dados que o RD Station envia.

Passo a passo para realizar a integração:

1. No RD Station, clique no nome da sua conta (canto superior direito) e selecione Integrações;
2. Em Webhooks, clique em Configurar. Na tela seguinte, clique em Criar Webhook. Você vai ver uma nova tela com alguns campos a serem preenchidos:
   1. Nome: defina um nome para sua integração. O ideal é criar um nome que identifique para qual ferramenta essas informações estão sendo enviadas. Exemplo: Envio para CRM X;
   2. URL: cole a URL da ferramenta que vai receber os dados do RD Station Marketing com as informações do lead;
   3. Gatilho: escolha o gatilho que vai acionar o envio da notificação:
      • 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 ou por um fluxo de automação.
3. Ao clicar no botão Salvar Webhook, você vai ser redirecionado para a tela de Webhooks configurados. Nela, você pode validar se a integração com o webhook funcionou. Para isso, clique no botão Verificar;
4. Se a integração estiver funcionando corretamente, você vai receber uma resposta positiva. Caso contrário, você vai receber uma mensagem de erro com indicação do que fazer em seguida.

Importante

A resposta negativa abaixo é a mais comum, indica que a URL destino não representa um servidor disponível (está incorreta) ou que o servidor destino não usa um certificado de segurança, o que é necessário para conseguir ser validado pelo nosso webhook. Em ambos os casos, o ideal é validar esses pontos com o seu desenvolvedor ou suporte da ferramenta que lhe forneceu a URL.

Exemplo de dados enviados pelo RD Station

Os dados serão enviados seguindo a estrutura abaixo, que é a de um JSON padrão:

{
 "leads": [
 {
 "id": "390319847",
 "email": "teste@webhook.com",
 "name": "Fulano Suporte RD",
 "company": null,
 "job_title": "Analista",
 "bio": null,
 "public_url": "http:\/\/rdstation.com.br\/leads\/public\/807029c7-267f-4225-8428-87ae2dab34c3",
 "created_at": "2018-09-26T17:57:10.189-03:00",
 "opportunity": "true",
 "number_conversions": "1",
 ...
 }] 
} 

Seu desenvolvedor também pode observar exemplos de pacotes de dados de teste direto dos leads da sua conta. Para isso, ele pode usar algum serviço gerador de URLs temporárias receptoras de dados, como exemplo: Beeceptor. 
 

Estes serviços podem gerar URLs temporárias, que você pode usar em seu Webhook no lugar da URL final para disparar o teste e, então, observar o resultado no site do serviço gerador da URL. 

Informações adicionais

O padrão JSON enviado é único e imutável, ele sempre vai mandar todas as informações disponíveis (que podem ser checadas na versão completa) o que inclui todos os campos personalizados que foram preenchidos.

Para testar, o ideal é disparar um lead que tenha todos os campos preenchidos. Como os campos sempre são enviados em um mesmo padrão, é importante que a ferramenta que vai recebê-los observe esses exemplos para programar a melhor forma de lê-los e guardar os dados da melhor forma. A função de guardar os dados fica sob controle da ferramenta destino.