Integração Rubeus
O Workchat possui integração nativa com o Rubeus, para geração de Leads no CRM e disparos ativos pelo Workchat com base nos dados e fluxos de automação do Rubeus.
Para essa integração, é necessário ter alguns cadastros no CRM Rubeus (canal, processos, tipos de evento, campos personalizados e fluxos de automação) e no Workchat (opções de menu, WebHook e um sistema de integração com Rubeus).
Abaixo, temos todos os passos para os cadastros, na ordem necessária para configuração da integração.
Cadastros no Rubeus
Canal
1. No canto superior direito, clique no nome de usuário e vá em “Integrações”
2. Após isso, acesse a aba de “Canais/Api” e clique em “Adicionar”
3. Ao adicionar o canal, defina o nome do canal como “Workchat” e defina qual a prioridade deseja utilizar (recomendamos prioridade baixa). Após isso, clique em “Salvar”
IMPORTANTE: Nesse campo, não deve ser informado nenhum URL. Então, o campo deve ficar em branco.
4. Após ter o canal criado, é necessário copiar o “Token” do canal e o o “Código do canal” que serão utilizados para montar o WebHook no Workchat
Nota: Quando clicar para copiar o token, será necessário fazer a autenticação com a conta Rubeus para ter acesso ao token completo.
Propriedade (campo customizado)
Esse campo será necessário para fazer a regra de associação entre o Lead que vem da integração no processo e etapa desejáveis no Rubeus.
1. No canto superior direito, clique no nome de usuário e vá em “Definições do sistema”
2. Em “Propriedades” adicione uma nova para ter o campo do processo que fará a associação nos “Tipos de Eventos”
3. Essa propriedade precisa ter um nome fácil para identificar e buscar nos demais cadastros, e seguir as seguintes regras:
A. Local: Registro de processo
B. Tipo: Texto
C. Multivalorado: não
D. Opções pré-definidas: não
Após isso, clique em “Salvar”
Após cadastrar a propriedade, é necessário salvar o código da mesma, confirme abaixo:
Tipos de evento
Os tipos de evento serão os itens que irão cadastrar o Lead, trazer o histórico de conversas e a resposta da pesquisa de satisfação para o Rubeus. Serão necessários 3 eventos: “Cadastrado pelo ChatBot”, “Atualização de Conversa” e “Avaliou Atendimento”.
1. Acesse “Cadastros” e pesquise por “Tipos de eventos”
2. Clique em “Adicionar” para criar um novo evento
3. Com isso, crie os eventos para o canal criado anteriormente, conforme a configuração abaixo:
A. Cadastrado pelo chatbot
B. Avaliou atendimento
C. Atualização de conversa
Com todos os eventos salvos, é necessário pegar o ID de todos eles. O ID fica no URL do tipo de evento que conseguimos visualizar acessando o evento conforme abaixo
O ID do evento é o que fica após a última barra conforme abaixo
Fluxo de automação
O fluxo de automação fará com que os dados que vierem do Workchat serão relacionados a um processo que for definido aqui no Rubeus e na etapa específica que for definida no fluxo. Para isso:
1. Acesse a aba de “Estratégia” e selecione “Fluxos de Automação”
2. Clique para “Adicionar” e criar o novo fluxo que faça a automação para registrar os contatos com base no fluxo necessário
3. No cadastro do fluxo de automação, é necessário cadastrar as seguintes informações:
A. Nome do fluxo de automação;
B. Status do fluxo (deve estar como Ativado);
C. O processo que receberá os Leads vindos do Workchat pela integração;
D. Marque o canal criado anteriormente e defina como “Automático”.
Os primeiros cadastros do fluxo ficarão dessa forma:
4. Com as definições de processo e canal, será necessário cadastrar o “Fluxo de Relacionamento Automatizado” clicando em “Adicionar gatilho”
5. Selecione o Canal “Workchat” e o gatilho que será o “Cadastrado pelo chatbot” que terá como função registrar o contato no Rubeus e clique em “Adicionar”
6. Após isso, será necessário adicionar as ações conforme abaixo:
Primeira ação: Alterar etapa do registro: nessa ação, será necessário definir qual a etapa do processo que o Lead será registrado quando vier da integração do Workchat. Após isso, clique em “Adicionar”
Agora, deve ser adicionada a condição dessa ação
Nessa condição é preciso informar os seguintes itens:
a. Condição: deve ser marcado “Campo”
b. Entidade: deve ser marcado “Registro de processo”
c. Selecione o campo: o campo deverá ser o campo personalizado que foi criado anteriormente.
d. Regra: marque que a regra tem que ser “O texto é exatamente igual”; no tipo de validação, marque “Texto”; e por fim, coloque um código que será utilizado na integração nas configurações do Workchat.
Após isso, clique em “Adicionar”
Segunda Ação: Alterar dados do registro: isso servirá para salvar e atualizar os dados dos Leads no Rubeus. Após isso, clique em “Adicionar”
Agora, deve ser adicionada a condição dessa ação
Nessa condição é preciso informar os seguintes itens:
a. Condição: deve ser marcado “Campo”
b. Entidade: deve ser marcado “Registro de processo”
c. Selecione o campo: o campo deverá ser o campo personalizado que foi criado anteriormente.
d. Regra: marque que a regra tem que ser “O texto é exatamente igual”; no tipo de validação, marque “Texto”; e por fim, coloque um código que será utilizado na integração nas configurações do Workchat.
Após isso, clique em “Adicionar”
Após isso, o fluxo estará pronto, e para finalizar, basta clicar em “Salvar”
Código do processo
1. Para identificar o código do processo, acesse “Cadastros” e clique em “Processos”
2. Após isso, acesse o processo, e o código do processo estará no URL do navegador
Cadastros no Workchat
Webhook
No Workchat, para a integração funcionar corretamente, é necessário ter o Webhook. Veja como criar um Webhook para iniciar a configuração da integração:
1. No Workchat, acesse o menu de “Integrações” e selecione “Webhooks”.
2. Após isso, clique em “Adicionar webhook”
3. O Webhook deverá ter o prefixo “https://sitesrubeus.com.br/middles/teste1.php?” no URL e o restante será concatenado com base nos parâmetros cadastrados que serão:
A. token: token do Canal do Rubeus cadastrado anteriormente no CRM
B. origem: código do Canal do Rubeus cadastrado anteriormente no CRM
C. url: link da base Rubeus da instituição
D. idmenu: menu pai do dos itens de menu que serão enviados ao contato após completar a requisição
E. processos: códigos dos processos do Rubeus que farão parte da integração (receberão os Leads)
F. evt_atualizacao: código do evento de “Atualização de contatos” cadastrado no Rubeus
G. evt_avaliacao: código do evento de “Avaliou atendimento” cadastrado no Rubeus
H. campo_avaliacao: código da propriedade criada no Rubeus para integração. Aqui deverá ser cadastrado apenas o do número do código em diante. Exemplo: 1_compl_proc
I. evt_cadastro: código do evento de “Cadastrado pelo chatbot” cadastrado no Rubeus.
Com todos os parâmetros cadastrados, o Webhook ficará dessa forma:
4. Após cadastrar os parâmetros, é necessário cadastrar o cabeçalho da requisição com os dados do Workchat:
A. Api: URL da API do Workchat que é o link da sua base com -api após o nome da instituição. Exemplo: se o link de acesso a sua base é instituicao.worknow.chat o url da API será instituicao-api.worknow.chat
B. Usuario: usuario da base, de preferência o admin;
C. Senha: senha do usuário já cadastrado.
O cadastro ficará dessa forma
5. Para finalizar o Webhook, é necessário marcar as inscrições, que serão as ações do Workchat que serão os gatilhos para ativar o Webhook. Basta acessar a segunda aba do Webhook e marcar todas. Após isso, clique em “Gravar”
Integrações de sistema
1. Para ter a opção de menu que irá integrar com o Rubeus, é necessário primeiro criar um sistema te integração intitulado “Rubeus” no Workchat. Para isso, é preciso acessar o menu de “Integrações” e clicar novamente em “Integrações”
2. Após isso, clique em “Novo sistema de integração” para criar a integração com o Rubeus
3. Crie o sistema com os dados abaixo:
A. Nome: Rubeus
B. Código customizado: rubeus
Após isso, clique em “Gravar”
4. Com o sistema criado, clique em “Detalhes” para criar o ponto de integração
5. Dentro do sistema de integração, clique em “Adicionar Integração” e preencha os seguintes campos
A. Código customizado: deverá ser preenchido com “rb-contato” (caso coloque algum nome diferente, a integração não irá funcionar)
B. Nome: informe “Identifica contato” (esse nome é mais flexível. Pode colocar outro se achar necessário para ajudar na organização dos demais, caso queira ter outros pontos).
Ainda dentro dessa tela, será necessário cadastrar os parâmetros abaixo
Os parâmetros serão todos do tipo “String” com exceção do último que deverá ser um chekpoint para mandarmos os valores fixos de Base Legal, IdMenu e a Propriedade Personalizada que foi cadastrada anteriormente.
Os campos String serão os campos que o contato irá digitar um texto livre, e esse valor será salvo no Rubeus no campo informado em “Código do Campo”. Exemplo:
A. Texto de exibição: mensagem que irá solicitar o dado ao contato após ele ter iniciado a integração selecionando o menu que integra com o Rubeus. Esse texto pode ser “Qual o seu nome?” ou “Me informe seu nome para continuarmos o atendimento”. Não há valor fixo para esse texto.
B. Código do campo: aqui deve ser informado o código do campo do Rubeus onde o dado informado pelo contato será salvo. Assim, deve ser informado exatamente conforme o banco de dados do Rubeus exige para a integração funcionar corretamente. No caso do campo nome, o código é {{nome}} e o campo E-mail é {{emailPrincipal}}.
C. Tipo do campo: como nesse exemplo, o contato precisa digitar um valor, deve ser o tipo do campo “String”.
Após definir os valores, basta clicar em “Adicionar” e o parâmetro estará na lista:
IMPORTANTE: O último parâmetro sempre deve ser do tipo “Checkpoint” pois ele irá mandar os dados fixos para o Rubeus, após o contato ter digitado as informações solicitadas pela instituição. Os demais campos antes disso, serão do tipo “String” para o contato digitar os dados que serão salvos no Rubeus
O campo Checkpoint tem dados específicos que precisam ser cadastrados no código do campo. São eles:
A. Base legal: deve ser informado obrigatoriamente o código 4;
B. IdMenu: deve ser informado o ID do menu pai que será enviado após a integração processar e salvar os dados do contato no Rubeus. Exemplo:
Aqui, o IdMenu 17 possui o submenu com “Sobre a instituição”, “O que tenho de aula hoje?”, “2ª via de boleto” e os demais listados no print acima. Sendo assim, enviando o IdMenu 17 no checkpoint o contato receberá essas opções após a integração do Rubeus salvar os dados no CRM;
C. Evento campo personalizado: deverá ser informado o código da Propriedade criada no Rubeus junto com o código definido no fluxo de automação. Essa concatenação deve ser: “evento.camposPersonalizados.campopersonalizado_1_compl_proc”:”1″ (o número 1 é um exemplo dessa documentação. Caso a instituição queira, pode usar outra descrição.
Nesse exemplo, o código completo do checkpoint será: {{“baseLegal”:”4″,”idmenu”:”17″,”evento.camposPersonalizados.campopersonalizado_1_compl_proc”:”1″}}
Como o checkpoint não pede nenhum dado, e sim, manda as informações para o Rubeus, recomendamos que nessa mensagem informe ao contato para ele aguardar enquanto a requisição é processada ou até mesmo, pode ser colocado o link do termo de privacidade da instituição dizendo “Ao prosseguir, você concorda com os termos de privacidade da Instituição disponíveis no link …”
Com tudo devidamente cadastrado, basta clicar em “Gravar” para gerar a integração.
Com isso, a integração estará pronta para inserir em uma das suas opções de menu.
O IdMenu que é enviado no checkpoint também pode ser um menu pai inativo no Workchat, que foi criado apenas para ser feito o submenu enviado após a requisição. Dessa forma, o contato só recebe o subemenu desse IdMenu após passar pela integração com o Rubeus.
Opções de Menu
1. No menu da esquerda do Workchat, clique em “Opções de menu”
2. Clique em “Nova opção de menu” no canto inferior direito da tela
2. Crie um menu com a ação da opção de “Integrar com Sistema Externo” e marque a integração criada com o sistema Rubeus. Além disso, marque os seguintes campos:
A. Atalho da opção: valor que o contato irá digitar para selecionar essa opção de menu (Exemplo: 1);
B. Descrição: texto que será exibido junto com o atalho para o contato saber o que está selecionando (Exemplo: Quero ser aluno(a));
Considerando o exemplo acima, a lista de menus do bot da instituição terá uma linha com “1 – Quero ser aluno(a)”.
Após isso, clique em “Gravar”.
Com isso, todo contato que marcar essa opção, irá iniciar a integração com o Rubeus, onde o Workchat irá solicitar os dados parametrizados na interação, e salvar conforme o fluxo e eventos cadastrados no Rubeus.
Assim, é possível ter vários menus integrando com o Rubeus, cada um salvando em seu respectivo processo e etapa de inscrição.
Ficou com dúvidas? Entre em contato com o time técnico pelo nosso sistema de chamados clicando aqui ou pelo nosso formulário de suporte.
