Integração Webhook

Visão Geral

Este documento visa mostrar como é feita a integração de uma conta de CRM externa com a plataforma de prospecção utilizando o Webhook.

Sobre o Webhook

O Webhook disponível no Catacliente envia para outros sistemas as informações dos contatos marcados com qualquer nível de interesse.

Quando um Webhook é disparado?

O Webhook é disparado quando um usuário atribui pela primeira vez ou reclassifica o nível de interesse para um contato. O Webhook não é disparado caso o nível de interesse seja removido de um contato.

Passo-a-passo da integração

Na tela de configuração do Webhook, informe a URL de destino no campo especificado:

Tela de configuração do webhook

O botão “Testar Webhook” envia uma requisição de teste para a URL informada e validará se o Webhook foi enviado com sucesso. Exemplos de retorno:

Exemplo de webhook executado com sucesso

Exemplo de erro ao executar

Formato do Webhook

{ 
"contact": { 
"id": 0, 
"name": "Contato Teste", 
"invite_date": "2021-01-22 12:28:47", 
"accept_date": "2021-01-22 12:28:47", 
"collect_date": "2021-01-22 12:28:47", 
"reply_date": null, 
"linkedin_public_id": "contato-teste", 
"current_company": "Empresa Teste", 
"current_company_link": "http:\/\/linkpara.empresa.teste", 
"role": "Teste", 
"location": "S\u00e3o Paulo, Brasil", 
"email": "teste@empresateste.com", 
"phone": null, 
"interest_level": 2, 
"skills": [{ 
"skill": "skill 1", 
"endorsements": 1 
}, { 
"skill": "skill 2", 
"endorsements": 2 
}], 
"experiences": [{ 
"experience": "Experi\u00eancia 1", 
"company_link": "http:\/\/linkpara.empresa.teste" 
}] 
}, 
"contact_owner": { 
"id": 0, 
"name": "Usu\u00e1rio Teste", 
"email": "teste@teste.com" 
}, 
"campaign": { 
"id": 0, 
"name": "Campanha Teste", 
"description": "Descri\u00e7\u00e3o da campanha teste" 
}, 
"messages": [{ 
"sender_name": "Usu\u00e1rio Teste", 
"message": "mensagem de teste", 
"date": "2021-01-22 12:28:47", 
"pending_message": 0 
}] 
} 

Detalhamento dos campos disponíveis

Campo Descrição
contact.id Identificador numérico do contato.
contact.name Nome do contato.
contact.invite_date Data que o convite de conexão foi enviado.
contact.accept_date Data que o convite de conexão foi aceito
contact.collect_date Data que o contato foi inserido no sistema.
contact.reply_date Data em que o usuário respondeu à nota de convite.
contact.linkedin_public_id Identificador do perfil do usuário no LinkedIn.
contact.current_company Nome da empresa atual do contato.
contact.current_company_link URL da empresa atual do contato.
contact.role Cargo do contato.
contact.location Texto informando a localização do contato.
contact.email E-mail do contato.
contact.phone Telefone do contato (formato varia conforme o contato).
contact.interest_level Nível de interesse do contato. 1 – Interesse baixo 2 – Interesse médio 3 – Interesse alto
contact.skills Array com a lista de competências do contato. Dentro desse array, o campo “skill” informa o nome da competência, “endorsements” informa a quantidade de pessoas que confirmaram que o contato domina a competência em questão.
contact.experiences Array com a lista de experiências prévias do contato. Dentro desse array, o campo “experience” descreve o cargo que o usuário ocupou anteriormente, “company_link” informa a URL da empresa.
contact_owner.id Identificador numérico do usuário para o qual o contato está atribuído.
contact_owner.name Nome do usuário.
contact_owner.email E-mail do usuário.
campaign.id Identificador numérico da campanha usada.
campaign.name Nome da campanha.
campaign.description Descrição da campanha.
messages Array com a lista de mensagens trocadas com o contato.

Detalhamento do array de mensagens (messages)

Campo Descrição
sender_name Nome de quem enviou a mensagem.
message Conteúdo da mensagem.
date Data de envio da mensagem.
pending_message Flag que indica se a mensagem está pendente de envio ou não (apenas para mensagens enviadas pelo Catacliente). 0 – Mensagem não está pendente 1 – Mensagem ainda não foi enviada

Exemplo de recebimento de dados (PHP)

Integração com o Zapier

O Zapier fornece uma forma bem fácil de receber Webhooks e processá-los. Para isso, basta seguir a documentação da própria ferramenta em seu website.

Quando meu contato é enviado para o CRM?

O contato é enviado para o CRM em até 30 minutos após você marcá-lo com estrelas dentro do Catacliente.

imagem estrelas

Utilize a marcação de estrelas para nivelar o interesse de seus prospects. Para ler mais sobre o assunto, acesse nosso guia sobre FIltros.