Integração - Pipedrive

1 - Acessar a documentação de API do Pipedrive;

2 - Gerar API TOKEN dentro do Pipedrive;

3 - Criar um Campo personalizado de pessoa no Octadesk para salvar o ID do contato, gerado pelo Pipedrive; 

4 - Construir um Bot que capture o e-mail que pode ser usado para consulta na API do Pipedrive;

5 - Verificar se já existe um Contato no Pipedrive com a informação coletada pelo Bot;

6 - Usar regra de validação para direcionamento quando contato não existir na Pipedrive;

7 - Cadastrar o Contato gerado pelo Bot no Pipedrive;

8 - Verificar ID da etapa do funil dentro do Pipedrive;

9 - Criar uma oportunidade, a partir dos dados coletados pela criação do bot na Octadesk, escolhendo o funil que deseja utilizar.

Acesse o link da documentação de API da Pipedrive clicando aqui.

A documentação de API é um tutorial detalhado sobre como fazer integrações, a usaremos para encontrar as informações necessárias para realizar a integração.

Acesse o link do artigo Pipedrive sobre como encontrar o API Token clicando aqui.

A criação do API Token serve como a chave de acesso que vamos utilizar quando iniciarmos a integração. Basta ir até Configurações > Preferências pessoais > API e gerar um API Token como mostra o GIF abaixo:

O campo personalizado é onde iremos salvar o ID do Pipedrive, e  utilizá-lo na integração. Por isso precisamos criá-lo antecipadamente, como no exemplo abaixo.

Lembrando que é necessário ativá-lo e ativar também a opção de pesquisa.

Para que a integração com a Pipedrive funcione corretamente, temos que ter ciência que ela precisa de informação do cliente, e essa informação precisa ser perguntada em determinada fase do bot e a resposta ser salva.

Conseguimos capturar as informações do cliente nas fases de pergunta, podendo ser usadas perguntas prontas que o sistema da Octadesk oferece, ou criar as suas próprias, usando o “Pergunte qualquer coisa”.

Nesse exemplo, usaremos e-mail como dado para consultar se o contato já existe na base da Pipedrive.

Para fazer essa verificação iremos usar a etapa do Bot chamada “Conecte a outro sistema”, essa etapa nos permite realizar requisições na API da Pipedrive para efetuar uma consulta, vamos realizar uma requisição do tipo GET (Nos permite buscar ou consultar uma informação).

A API do Pipedrive é composta pelo subdomínio do cliente + o restante da URL que compõe o tipo de requisição que queremos fazer, logo, um exemplo de URL para consultar se um contato já existe é: https://SEUSUBDOMÍNIO.pipedrive.com/v1/persons/search

Veja como aparece no Bot:

Ao inserir a URL, outros campos e abas irão aparecer para preenchimento.

Iremos preenchê-las da seguinte forma:

Na opção PARAMS:

Chave: api_token

Valor: Seu API Token gerado no Pipedrive

Cadastre mais um parâmetro e preencha:

Chave: term

Valor: Clique na # ao lado do campo e selecione o e-mail

Na opção HEADER:

Chave: Content-Type

Valor: application/json

Após realizar a configuração acima, um campo de "Valide sua integração" será apresentado, iremos preenchê-lo com um e-mail para verificar se ele existe na Pipedrive, vinculado a um contato.

Importante ressaltar que a integração retornará os dados do Contato caso ele exista e retornará em branco caso ele não exista. Portanto, neste primeiro momento o ideal é utilizar um e-mail que exista na base, para que possamos testar se a integração está funcionando.

É possível ver uma configuração no Bot chamada “Salve as informações encontradas”, esse é um recurso que permite salvar as informações que a API da Pipedrive retornou em campos do Octadesk. Agora será o momento de utilizarmos o campo personalizado de pessoas que criamos na etapa 3 deste artigo, para salvarmos o ID do Contato .

Iremos selecionar o item “data.items.0.item.id”.

Ele representa o ID do Contato cadastrado lá no Pipedrive e, fazer com que essa informação seja salva vai nos permitir diferenciar contatos que existem no Pipedrive, dos contatos que não existem, afinal, se ele não existir a integração não retornará dado algum e o campo ID Pipedrive criado no Octadesk não será preenchido.

O Bot possui uma etapa chamada “Valide uma informação”, ela serve para validar se um campo em específico foi preenchido ou não, de acordo com o resultado da validação podemos configurar caminhos diferentes para o Bot.

Iremos validar através desse campo, o ID Pipedrive, se ele foi preenchido, usando a regra “Estiver Vazio”.

Ao configurar o Bot para validar se o campo ID Pipedrive está vazio ou não, será possível configurar um caminho diferente.

- Se a regra for válida: Significa que não existe um contato cadastrado na Pipedrive com o e-mail que usamos para validar a integração, portanto será necessário cadastrar esse cliente na Pipedrive.

- Se a regra não for válida: Significa que um existe um contato cadastrado na Pipedrive com o e-mail que usamos para validar a integração, portanto, não precisamos cadastrá-lo novamente.

Pensando naquele cliente que passou pelo fluxo do Bot e ainda não tem cadastro na Pipedrive, iremos criá-lo para que possamos ter seus dados na base.

Nesta etapa, iremos usar novamente a etapa do Bot chamada “Conecte a outro sistema”, Ao invés de utilizarmos o método GET, agora iremos cadastrar uma informação na Pipedrive via API, portanto, vamos utilizar o método POST (Enviar uma nova informação).

A URL da Pipedrive deve ser inserida no campo “Com quem você quer integrar?” e em seguida Enter.

A URL para a criação do contato é a seguinte: https://SEUSUBDOMÍNIO.pipedrive.com/v1/persons

Essa parte da integração você pode necessitar da ajuda de um desenvolvedor caso exista a necessidade de acrescentar mais informações que serão enviadas.

Na opção PARAMS:

Chave: api_token

Valor: Seu API Token gerado no Pipedrive

Cadastre mais um parâmetro e preencha:

Chave: term

Valor: Clique na # ao lado do campo e selecione o e-mail

 Na opção HEADER:

Chave: Content-Type

Valor: application/json

Na opção BODY, iremos preencher quais informações serão enviadas ao Pipedrive, este é um exemplo que pode ser utilizado:

{

  "name": "#nome-contato",

  "email": [

    "#email-contato"

  ],

  "phone": [

    "#tel-celular-contato"

  ]

}

Caso os campos das variáveis para teste não apareçam, apague as variáveis no body e insira novamente.

Caso tenha sucesso na integração, o contato será registrado dentro do Pipedrive, ok?

Agora será o momento de utilizarmos o campo personalizado de pessoas que criamos na etapa 3 deste artigo, para salvarmos o ID do Contato.

Iremos selecionar o item “data.id” e salvar com a variável criada para o Pipedrive.

O ID fica disponível na URL quando abre cada funil de vendas, como mostra abaixo.

O Pipedrive obrigatoriamente solicita o ID de um Contato para realizar a criação de um novo negócio, por isso, as etapas anteriores foram necessárias.

Nesta etapa, iremos usar novamente a etapa do Bot chamada “Conecte a outro sistema”, no método POST (Enviar uma nova informação).

A URL para a criação da oportunidade é a seguinte: https://SEUSUBDOMÍNIO.pipedrive.com/v1/deals

Ao inserir a URL, outros campos e abas irão aparecer para preenchimento.

Iremos preenchê-las da seguinte forma:

Na opção PARAMS:

Chave: api_token

Valor: Seu API Token gerado no Pipedrive

Cadastre mais um parâmetro e preencha:

Chave: term

Valor: Clique na # ao lado do campo e selecione o ID Pipedrive

Na opção HEADER:

Chave: Content-Type

Valor: application/json

Na opção BODY, iremos preencher quais informações serão enviadas ao Pipedrive, este é um exemplo que pode ser utilizado:

{

  "title": "#nome-contato",

  "person_id": "#id-pipedrive-contato",

  "pipeline_id": 3

}

A estrutura acima é conhecida como Body de uma requisição, ela segue alguns padrões conforme orientados na API do Pipedrive e é uma das partes da integração que pode necessitar da ajuda de um desenvolvedor caso exista a necessidade de acrescentar mais informações que serão enviadas.

Caso precise saber o número de cadastro do seu contato, basta abrir o contato e o número dele estará na URL. Nesse exemplo, ele é o número 2.

Vamos realizar o teste para verificar se temos sucesso na integração, e a deal/oportunidade será registrada dentro do Pipedrive.