Webhook: Integração customizável com sistema próprio

Como funciona

Essa integração possibilita o envio de dados em tempo real da Plataforma Rubeus para uma aplicação de destino.

O que esta integração faz?

Ela permite enviar dados do Rubeus para outras aplicações que disponham de uma URL de entrada de dados. Para isso, 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;
• A URL deve ser fixa, não é possível parametrizar URLs na parametrização dos Webhooks.

Passo a passo para realizar a integração

• Em sua Plataforma Rubeus, clique na engrenagem (configurações no canto superior direito) e selecione Integrações;
• Em Webhooks, clique em Adicionar. Na tela seguinte, você vai ver uma nova tela com alguns campos a serem preenchidos:

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 aplicação X;

URL: cole a URL da ferramenta que vai receber os dados do Rubeus com as informações enviadas;

Gatilho: escolha o gatilho que vai acionar o envio da notificação:

• Ao clicar no botão Salvar, 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 Testar;
  
  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 você deve realizar em seguida.

Observações importantes

A resposta negativa abaixo é a mais comum, indica que a URL destino não representa um servidor disponível (está incorreta). 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 pela Plataforma Rubeus

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

 CONTATO

{

"id": "341",

"codigo": "COD156",

"nome": "Matheus de Almeida Amaral",

"nomeSocial": null,

"imagem": null,

"cpf": "12547854577",

"dataNascimento": "1997-10-22",

"endereco": "Rua Teste",

"numero": "535",

"bairro": "Jardim das Ruas",

"cidade": "São Paulo",

"uf": "SP",

"genero": "Masculino",

"origens": [{

"id": "1",

"nome": "CRM"

}],

"emails": {

"principal": "[e-mail]",

"secundarios": null

},

"telefones": {

"principal": "2323342342",

"secundarios": ["2323342341"]

},

"tagsRDStation": null,

"camposPersonalizados": {

"perfil": "Administrador"

}

}

ATIVIDADE

{

"id": "108",

"contato": {

"id": "635",

"codigo": "COD156"

},

"vencimento": "2019-02-01 00:25",

"duracao": "5",

"descricao": "Ligação",

"registroProcesso": "150",

"curso": {

"id": "21",

"codOferta": "ADM_2",

"codCurso": "ADM"

},

"responsavel": {

"id": "15",

"nome": "Marcos Souza",

"email": "[e-mail]"

},

"resumoAtual": {

"id": "1",

"nome": "Não contactado"

},

"concluido": "0",

"formaContato": "Ativo"

}

EVENTO

{

"id": "934",

"tipo": {

"id": "36",

"codigo": null,

"nome": "Entrou na etapa Convocado - Captação"

},

"descricao": "<p>Iniciou a inscrição<\/p>",

"contato": {

"id": "635",

"codigo": "COD156"

},

"curso": {

"id": "21",

"codCurso": "ADM",

"codOferta": "ADM_2"

},

"dataAgendamento": {

"data": "2019-02-01 06:27",

"tipo": "PROVA"

}

}

Temos um modelo completo dos retornos por entidade disponível como: contato, atividade e evento. Para testar o serviço de envio de dados, uma boa opção é 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

Todas as informações serão enviadas no padrão JSON o que inclui todos os campos personalizados que foram preenchidos.

Quando alguma informação na estrutura não estiver disponível, o retorno padrão será NULL.