O Webhooks facilita a comunicação com aplicativos de terceiros enviando notificações instantâneas da Web sempre que um evento ocorre no Zoho CRM. Com o Webhooks, você pode configurar URLs HTTP e associá-las a regras de fluxo de trabalho para automatizar todo o processo de notificação. Para obter informações gerais sobre Webhooks, consulte webhooks.org.
Cenários
- Depois de fechar um negócio no Zoho CRM, você pode enviar as informações do cliente para o software de contabilidade (por exemplo, Zoho Books) e gerar automaticamente uma fatura para o cliente;
- Você pode adicionar assinantes à lista de discussão no software de Marketing por e-mail (por exemplo, MailChimp) com base em leads ou contatos coletados do seu site usando os formulários da Web do Zoho CRM;
- Você pode acionar lembretes por SMS para representantes de vendas em campo sobre reuniões com clientes, demonstrações e outros eventos;
- Você pode gerar uma estimativa em seu software de Contabilidade (por exemplo, Zoho Books) assim que o estágio de oportunidade for alterado de Prospecção para Cotação de Preço;
- Depois de fechar um negócio no Zoho CRM, você pode calcular automaticamente a comissão para representantes de vendas no aplicativo de comissão de vendas criado sobre o Zoho Creator.
Público-alvo
- Usuários do CRM com permissões de Gerenciar Fluxo de Trabalho;
- Programadores com habilidades em API REST.
Disponibilidade
Permissão necessária
Os usuários com permissão Gerenciar fluxo de trabalho em seu perfil podem acessar esse recurso.
Nome do campo
| Descrição
| Limites e tipo de dados |
Nome
| Especifique o nome do webhook.
| Alfanumérico (100)
|
Descrição
| Adicione uma descrição para o webhook.
| 200 caracteres
|
Método
| Selecione o tipo de método de API - POST, GET, PUT e DELETE. O POST permite que você insira os valores nos campos do aplicativo associado; O GET permite que você recupere informações para atualizar nos campos de um registro no Zoho CRM; PUT atualiza o valor existente no aplicativo associado; DELETE exclui o valor existente no aplicativo associado.
Nota: por padrão, o sistema selecionará o método POST.
| Lista de opções |
URL a ser notificado | Especifique a URL da API REST do aplicativo de terceiros. | 300 caracteres |
Tipo de autorização | Selecione o tipo de autorização desejado - Geral (inclui API Key ou AUTH Token) e Conexão (OAuth, API Key etc.) | Botão de opção |
Conexão | Se a opção Conexão estiver selecionada, você poderá escolher a conexão apropriada na lista. Nota: a opção de conexão listará apenas as conexões ativas existentes. Escolha uma conexão existente ou crie uma nova. Leia mais sobre conexões.
Se uma nova conexão for adicionada, clique no ícone de atualização presente perto do campo Escolher conexão, para exibir a conexão recém-adicionada na lista suspensa. | Botão de opção |
Módulo
| Escolha um dos módulos do Zoho CRM.
Módulos suportados:
- Módulo primário de CRM, como leads, contas, contatos, negócios etc.;
- Reuniões e Tarefas.
Nota: você não pode configurar webhooks para os módulos Logs de Chamadas e Notas.
| Lista de opções |
Cabeçalho | Nota: Parâmetros de URL - Uma URL consiste em informações sobre o gatilho entre o Zoho CRM e outros aplicativos. O gatilho de informações em uma URL do webhook é normalmente classificado como Cabeçalho e Corpo. Os parâmetros adicionados à seção de cabeçalho terão dados que serão sincronizados com o cabeçalho de outro aplicativo. Além das informações de gatilho, o cabeçalho geralmente pode transportar chaves de API / tokens de autenticação. Para formar os parâmetros de URL do cabeçalho, escolha Parâmetros do módulo e/ou parâmetros personalizados.
| Limite de cabeçalho: um webhook pode acomodar até 10 parâmetros de URL de cabeçalho. |
Parâmetros do módulo | Especifique o Nome do parâmetro, o tipo de parâmetro e o Valor do parâmetro correspondente. Adicione vários parâmetros para criar a cadeia de caracteres. Esse formato é dinâmico e o CRM oferece as opções para escolher os valores de campo na lista de opções. Tipo de parâmetro inclui | -
|
Parâmetros personalizados | Especifique o Nome do parâmetro do CRM e o valor correspondente para o webhook. O nome e o valor são conforme configurado. Como o valor no parâmetro personalizado é estático, esse par chave/valor é usado principalmente para enviar os tokens de autenticação, tokens de segurança, chave de API etc. |
|
Corpo | A parte Corpo da URL contém informações na cadeia de caracteres de URL sobre o gatilho para outro aplicativo. Você pode optar por usar Form-Data ou Raw na lista de opções para configurar a parte do corpo da URL. Form-Data: permite que você construa a parte do corpo da URL simplesmente anexando juntos, Nome do parâmetro e Tipo de parâmetro ou Valor do parâmetro. Você pode criar dados de formulário de 3 maneiras - Parâmetros de módulo, parâmetros personalizados e parâmetros definidos pelo usuário. Parâmetro definido pelo usuário: especifique o nome do parâmetro e o valor do parâmetro. Esse formato também é dinâmico, com a capacidade de escolher o tipo de valor na opção inserir campo de mesclagem usando #; Dados brutos: além de formar os parâmetros, você também pode gravar seus próprios valores de dados no editor de texto se selecionar a opção Dados brutos como tipo de corpo. Você pode inserir dados em um dos seguintes formatos XML, JSON, HTML ou TEXT. Você também pode usar o recurso # mesclar campo para denotar um valor de campo dentro do script.
| Limite de dados brutos: um webhook pode conter até 15000 caracteres no editor de texto de dados brutos. |
URL de visualização
| A URL de visualização exibe a URL do webhook completa para o método de solicitação GET e DELETE, enquanto para o método POST e PUT, somente a URL configurada é exibida.
Para visualizar a URL, clique no ícone Atualizar na parte inferior do editor de texto. Você também pode copiar a URL. | Somente leitura |
Notas:
Se o Método de solicitação estiver selecionado como POST ou PUT, os tipos de configuração - Cabeçalho e Corpo serão exibidos;
Se o Método de solicitação for DELETE, o cabeçalho e Form-Data da configuração do corpo serão exibidos;
Se o Método de solicitação for selecionado como GET, somente o corpo do tipo de configuração no formato de dados de formulário será exibido.
A configuração do Webhooks inclui as três etapas a seguir:
- Crie um webhook;
- Associe o webhook a uma regra de fluxo de trabalho;
- Teste a integração do webhook.
Para criar um webhook
- Vá para Configurar > Automação > Ação > Webhooks;
- Na página Webhooks, clique em Configurar Webhook;
- Na página Novo Webhook, especifique todos os parâmetros necessários;
- Clique em Salvar.
Reconhecer valores de campo de mesclagem sem suporte
Às vezes, você pode notar que os valores do campo de mesclagem que você usou no editor de Descrição do Valor do seu webhook agora são exibidos como ${Unsupported_Field}. A seguir estão algumas das razões pelas quais isso acontece.
Campo personalizado excluído
O campo de mesclagem cujo valor você inseriu foi excluído. Se o editor de Descrição de Valor do seu webhook continuar a conter o valor do campo de mesclagem de um campo excluído, esse valor será exibido como ${Unsupported_Field}.
Campo de pesquisa personalizado excluído
O campo de pesquisa personalizado cujo valor você inseriu foi excluído. Se o editor de Descrição de Valor do seu webhook continuar a conter o valor do campo de mesclagem de um campo de pesquisa excluído, esse valor será exibido como ${Unsupported_Field}.
Campo não listado na lista de Campos de Mesclagem Disponíveis
Se você tiver usado o valor do campo de mesclagem de um campo que não está entre a lista de campos de mesclagem disponíveis para o módulo selecionado, ele será exibido como ${Unsupported_Field}.
Por exemplo, se você inserir o valor do campo de mesclagem ${Leads.Lead Id} no editor de Descrição do Valor do módulo Negócios, ele será exibido como um campo sem suporte.
Integrações/Recursos desativados
Quando um recurso ou integração tiver sido desativado para sua conta, os campos que foram criados como parte da integração também não estarão disponíveis para a conta após a desativação. Se um valor de campo de mesclagem desse campo tiver sido inserido no editor de Descrição do Valor, ele será exibido como ${Unsupported_Field}. Isso é aplicável aos seguintes recursos/integrações.
- Integração com o Google Ads - Os campos do Google Ads que já não estão disponíveis não serão suportados;
- Acompanhamento de visitantes (Zoho SalesIQ Integration) - Os campos de acompanhamento de visitantes que não estão mais disponíveis não serão suportados;
- Gestão do Território - Os campos que não estão mais disponíveis não serão suportados;
- Multimoeda - Moedas que foram desativadas não serão suportadas.
Para associar o webhook a uma regra de fluxo de trabalho
- Vá para Configurar > Automação > Fluxo de Trabalho;
- Na página Regras de Fluxo de Trabalho, clique em Criar Regra;
- Na página Criar Nova Regra, especifique os parâmetros da regra de fluxo de trabalho;
- Em Ações de Fluxo de Trabalho, selecione webhooks;
- No pop-up Chamar Webhook, selecione o webhook necessário e clique em Associar;
Clique em Salvar.
Para testar a integração do webhook
- Adicione dados de teste no CRM de acordo com seus critérios de regra de fluxo de trabalho;
- Em seu aplicativo, verifique os dados recebidos do Zoho CRM por meio de notificação do webhook;
- Se houver um erro ou incompatibilidade de dados, modifique as configurações do webhook no Zoho CRM;
- Continue esse teste até obter os dados necessários do Zoho CRM para seu aplicativo.
Observações importantes
- Você pode associar até 6 (1 Ação Instantânea e 5 Ações Baseadas em Tempo) webhooks por regra de fluxo de trabalho.
- Você pode transferir dados para um máximo de 10 campos do CRM do Zoho CRM para aplicativos de terceiros usando o webhook;
- Não é possível recuperar dados de outros aplicativos para o Zoho CRM usando webhooks;
- Você deve atualizar o tíquete de API regularmente de acordo com os limites em aplicativos de terceiros;
- Você não receberá nenhuma notificação por e-mail se a integração do Webhook parar de funcionar devido a qualquer problema em uma API de terceiros;
- Em webhooks, permitimos no máximo 10000 caracteres para o formato definido pelo usuário, enquanto usamos o método POST;
- Se houver alguma falha no processo, o Webhook enviará uma notificação primeiro, o sistema Zoho CRM enviará uma segunda notificação após 15 minutos. Depois disso, o sistema não enviará nenhuma notificação do Webhook para esse gatilho de fluxo de trabalho específico;
- Se você exceder a contagem máxima por dia, o sistema não enviará notificações restantes do Webhook para aplicativos de terceiros e notificará a falha ao Administrador;
- No campo URL para Notificar, se você quiser especificar um número de porta, observe que apenas 80 ou 443 números de porta são suportados;
- O Zoho CRM oferece uma opção para selecionar o formato de Data/Hora e o Fuso Horário necessários durante a configuração do parâmetro Webhook;
- Limites para Webhooks:
- Edição profissional - 50.000 chamadas/dia ou 100 chamadas/usuário/dia (o que for menor);
- Enterprise Edition - 500.000 chamadas/dia ou 500 chamadas/usuário/dia (o que for menor);
- Edição final - 1.000.000 de chamadas/dia ou 1000 chamadas/usuário/dia (o que for menor).
Cenário de negócios 1
Calcule a Comissão de Vendas no Zoho Creator App ao fechar uma Oportunidade no Zoho CRM.
Propósito
Os Gerentes de Vendas e a equipe de Folha de Pagamento podem usar o aplicativo Comissão de Vendas para calcular a remuneração de seus Representantes de Vendas de acordo com uma fórmula predefinida que foi definida pela sua organização (por exemplo, 2% do contrato fechado ou do valor das vendas). Este aplicativo ajuda você a reduzir entradas manuais, minimizar erros e economizar tempo ao calcular a comissão para seus representantes de vendas. Além disso, os representantes de vendas podem rastrear suas comissões mensais em um local central.
Pré-requisito
- Conta no Zoho Creator Application;
- Permissão para acessar a API do Zoho;
- Familiaridade com o Zoho Creator.
Procedimento
- Criar o aplicativo Sales Commission no Zoho Creator (consulte o Tutorial do Zoho Creator sobre como criar aplicativos);
- Configurar o webhook no Zoho CRM;
- Configurar a Regra de Fluxo de Trabalho;
- Testar a integração do webhook.
Etapa 1: Criar o aplicativo Sales Commissions no Zoho Creator
No Zoho Creator, crie o aplicativo Sales Commission com os seguintes campos:
- Representante de Vendas;
- Nome do negócio;
- Nome do Cliente;
- Valor da Oportunidade;
- Tipo de negócio: Novo negócio ou negócio existente;
- Data de Encerramento;
- Comissão de Vendas.
Etapa 2: Configurar o Webhook
Selecione os seguintes Campos no módulo Deal ao configurar parâmetros definidos pelo usuário:
- Nome do negócio;
- Data de Encerramento;
- Tipo;
- Proprietário do Registro;
- Quantidade;
No Webhook, especifique os seguintes detalhes:
URL para notificar:
Parâmetros "raw" do tipo de corpo (XML, texto, JSON ou HTML)
- <ZohoCreator>
- <applicationlist>
- <application name='sales-commissions'>
- <formlist>
- <form name='Commissions'>
- <add>
- <field name='Name'>
- <value> ${Potentials.Potential Name} </value>
- </field>
- <field name='Closed_Amount'>
- <value> ${Potentials.Amount} </value>
- </field>
- <field name='Closing_Date'>
- <value> ${Potentials.Closing Date} </value>
- </field>
- <field name='Customer_Name'>
- <value> ${Accounts.Account Name} </value>
- </field>
- <field name='Type_of_Business'>
- <value> ${Potentials.Type} </value>
- </field>
- <field name='Sales_Rep'>
- <value> ${Potentials.Potential Owner} </value></field>
- </add>
- </form>
- </formlist>
- </application>
- </applicationlist>
- </ZohoCreator>
Nota
- Na cadeia de caracteres XML acima, name representa o campo no Zoho Creator App e o valor dos dados deve ser enviado por push do Zoho CRM;
- <nome do aplicativo> é o nome do aplicativo que contém o formulário no Zoho Creator. Obtenha o nome do aplicativo na guia Configurações do aplicativo do Zoho Creator;
- <nome do formulário> é o nome do formulário em que você edita registros no Zoho Creator. Obtenha o nome do formulário nas Configurações do formulário da sua conta do Zoho Creator;
- Verifique se o formato de data no aplicativo Criador está no formato aa-MM-dd. Você pode alterar o formato de data nas Configurações do aplicativo da sua conta do Zoho Creator.
Parâmetros personalizados:
Parâmetro
| Descrição
|
Autorização | Configure uma conexão com o criador no Connections em Developer Space e faça o mesmo no tipo de autorização do webhook no CRM. |
zc_ownername*
| Especifique o nome do proprietário do aplicativo da sua conta de criador. |
Nota
- Para recuperar dados de outros aplicativos para o Zoho Creator, você deve especificar o nome de usuário e o tipo de autorização.
Etapa 3: Configurar a regra de fluxo de trabalho
Siga estas etapas na página Regra de Fluxo de Trabalho:
- Configure os critérios de fluxo de trabalho como:
- Tipo é Novo Negócio;
- Etapa é Closed Won;
- Clique em Avançar;
- Selecione webhook como ação instantânea;
- No pop-up Chamar Webhook, selecione o webhook necessário na lista e clique em Associar;
- Salve a regra de fluxo de trabalho.
Associar Webhook à regra de fluxo de trabalho
Etapa 4: Testar sua integração
- Adicione um negócio de teste no CRM com os campos Tipo e Estágio como um Novo Negócio e Fechado Ganho, respectivamente. Ao inserir dados de teste, verifique se Valor, Dados de Fechamento, Proprietário do Registro, Nome da Conta e Nome do Negócio também são inseridos;
- Abra seu aplicativo de comissão de vendas no Zoho Creator e verifique os dados do CRM.
Se você não recebeu nenhum dado, modifique a configuração do webhook e continue o teste. Após o teste bem-sucedido, remova as entradas de teste e implemente essa integração para os usuários do CRM.
Cenário de negócios 2
Envie alertas SMS para clientes e representantes de vendas.
Propósito
Um pagamento de um cliente é devido hoje. Você pode enviar um SMS com a data de vencimento do pagamento, o nome do cliente e os detalhes do valor para seu representante de vendas associando o webhook à ação baseada em tempo na regra de fluxo de trabalho.
Pré-requisito
- Conta no serviço de gateway SMS;
- Permissão para acessar Regras de Fluxo de Trabalho.
Procedimento
- Criar uma conta no serviço de gateway do SMS;
- Configurar o webhook no Zoho CRM;
- Configurar a Regra de Fluxo de Trabalho;
- Testar a integração do webhook.
Etapa 1: Criar uma conta no serviço de gateway do SMS
No seu serviço de gateway SMS, crie uma conta e obtenha estes detalhes para configurar o webhook:
- Representante de Vendas;
- Nome do negócio;
- Nome do Cliente;
- Valor da Oportunidade;
- Tipo de Negócio: Novo Negócio;
- Etapa: Fechado Venceu;
- Data de Vencimento do Pagamento (campo personalizado).
Atualmente, a Zoho tem parceria com os seguintes provedores de SMS Gateway:
- SMS em massa;
- Clickatell;
- Magia da Tela;
- Folha de valor;
- Soluções Infinitas.
Você pode comprar créditos de SMS e detalhes da API dos fornecedores acima.
Etapa 2: Configurar o Webhook
Selecione os seguintes campos no módulo Leads ao configurar parâmetros definidos pelo usuário:
- Nome de domínio do gateway SMS;
- Nome de usuário;
- Token de autenticação.
No webhook, especifique os seguintes detalhes:
URL para notificar:
- http://<Nome de Domínio>/smsgateway/post - método POST
Parâmetros definidos pelo usuário (XML ou JSON)
- <?xml version="1.0"?>
- <m:Biblioteca xmlns:m="http://www.screen-magic.com/" xmlns="http://www.defns.com/">
- <>xxxx@xxxxx.com</nome de usuário>
- <senderid>SMS-Provider</senderid>
- <accountid>XXXXXXX</accountid>
- <authtoken>XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</authtoken>
- <message mobilenumber="${User.Mobile}">Hi ${User.Last Name}, O valor do pagamento ${Potential.Amount} vence hoje a partir de ${Account.Name}. Entre em contato com ${Contact.Last Name} o mais rápido possível</message>
- </m:Biblioteca>
Nota
Na cadeia de caracteres XML acima, usamos o gateway Screen Magic para fins de demonstração.
Etapa 3: Configurar a regra de fluxo de trabalho
Siga estas etapas na página Regra de Fluxo de Trabalho:
- Configure os critérios de fluxo de trabalho como:
- Tipo é Novo Negócio;
- Estágio está fechado ganhou;
- Escolha Data de encerramento;
- Selecione o webhook como uma ação baseada em tempo;
- Salvar regra de fluxo de trabalho.
Critérios de regra de fluxo de trabalho
Associar Webhook à regra de fluxo de trabalho
Etapa 4: Testar sua integração
- Adicione um negócio de teste no CRM com os campos Tipo e Data de Vencimento do Pagamento como uma Empresa Existente e Hoje, respectivamente. Ao inserir dados de teste, verifique se Valor, Dados de Fechamento, Proprietário do Registro, Nome da Conta e Nome do Negócio também são inseridos;
- No seu telemóvel, verifique o alerta SMS. Se não tiver recebido SMS, modifique a configuração do webhook e continue a testar. Após o teste bem-sucedido, remova as entradas de teste e implemente essa integração para os usuários do CRM.
Consultar códigos de erro
Às vezes, a execução do Webhook pode falhar devido a um dos seguintes motivos:
- Solicitação incorreta - Um parâmetro necessário pode estar faltando;
- Solicitação não autorizada - Um token de autenticação inválido é fornecido;
- Falha na solicitação - Os parâmetros eram válidos, mas a solicitação falhou;
- Página não encontrada - Se o item solicitado não existir;
- Erro de terceiros - Devido a uma falha no aplicativo de terceiros;
- Servidor de terceiros não disponível - Conexão Disno servidor de API de terceiros;
- Falha no processo interno - Se houver um erro no processamento do webhook;
- Limite de dia atingido - Se a organização tiver atingido o limite máximo para o dia;
- URL inválida - Se a URL for vulnerável a SSRF ou uma URL inválida;
- Tempo limite do soquete - Se o webhook for invocado, mas a resposta não for recebida até 10 segundos.
Exibir gráfico de uso de Webhooks
O Zoho CRM fornece gráficos que mostram as estatísticas de uso diário ou semanal de webhooks em vários recursos. Você pode exibir o uso do alerta ao ir para a Configuração > Automação > Ação > Webhooks.
O link
Mais informações fornece informações detalhadas sobre as estatísticas de uso. Por favor, note que o gráfico cobrirá as estatísticas de uso dos últimos 7 dias.