Lista de campos no Webhook

Definir webhooks

A configuração de Webhooks inclui as três etapas a seguir:

• Crie um webhook.
• Associe um webhook a uma regra de fluxo de trabalho.
• Teste a integração do webhook.

Para criar um webhook

1. Vá para Configuração > Automação > Ações > Webhooks.
2. Na página Webhooks , clique em Configurar Webhook.
3. Na página Novo Webhook, especifique todos os parâmetros necessários.
4. Clique em Salvar.

Reconhecer valores de campos de mesclagem não suportados

Às vezes, você pode notar que os valores do campo de mesclagem usados no editor Descrição de Valor do webhook agora são exibidos como ${Unsupported_Field}. A seguir estão alguns dos motivos para isso.

Campo personalizado excluído

O campo de mesclagem cujo valor você inseriu foi excluído. Se o editor Descrição de Valor do webhook continua a conter o valor de 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 Descrição de Valor do webhook continua a conter o valor de campo de mesclagem de um campo de pesquisa excluído, esse valor será exibido como ${Unsupported_Field}.

Campo não listados 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á na 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 Descrição de Valor para o módulo Oportunidades, ele será exibido como um campo não suportado.

Integrações/recursos desativados

Quando um recurso ou integração já foi desabilitado para a 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 de tal campo foi inserido no editor Descrição de Valor, ele será exibido como ${Unsupported_Field}. Isso é aplicável aos seguintes recursos/integrações.

• Integração do Google AdWords - os campos do Google AdWords que não estão mais disponíveis não serão suportados.
• Rastreamento de visitantes (integração do Zoho SalesIQ): campos de rastreamento de visitantes que não estão mais disponíveis não serão suportados.
• Gerenciamento de território - campos que não estão mais disponíveis não serão suportados.
• Múltiplas moedas - moedas que foram desativadas não serão suportadas.

Para associar o webhook a uma regra de fluxo de trabalho

1. Vá para Configuração > Automação > Regras de Fluxo de Trabalho
2. Na página Regras de Fluxo de Trabalho, clique em Criar Regra.
3. Na página Criar Nova Regra, especifique os parâmetros da regra de fluxo de trabalho.
4. Em Ações de Fluxo de Trabalho, selecione webhooks.
5. Na janela pop-up Chamar Webhook, selecione o webhook necessário e clique em Associar.
6. Clique em Salvar.

Para testar a integração do webhook

1. Adicione dados de teste no CRM de acordo com os critérios da sua regra de fluxo de trabalho.
2. Em seu aplicativo, verifique os dados recebidos do Zoho CRM pela notificação do webhook.
3. Se houver um erro ou incompatibilidade de dados, modifique as configurações do webhook no Zoho CRM.
4. Continue esse teste até obter os dados necessários do Zoho CRM para o seu aplicativo.

Notas importantes

• Você pode associar até 6 webhooks (1 ação instantânea e 5 ações baseadas no tempo) por regra de fluxo de trabalho.
• Você pode transferir dados para um máximo de 10 campos de 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 de aplicativos de terceiros.
• Você não receberá qualquer notificação de e-mail, se a integração do Webhook parou de funcionar devido a qualquer problema em uma API de terceiros.
• Em webhooks, permitimos o máximo de 10.000 caracteres para formato definido pelo usuário, usando o método POST.
• Se houver alguma falha no processo, o Webhook, primeiro, enviará uma notificação então o sistema Zoho CRM enviará uma segunda notificação depois de 15 minutos. Depois disso, o sistema não enviará quaisquer notificações do Webhook para esse acionador de fluxo de trabalho em particular.
• Se você exceder a contagem máxima por dia, o sistema não enviará as 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 os números de porta 80 ou 443 são suportados.
• O Zoho CRM dá uma opção para selecionar o formato desejado para data/data e hora e o fuso horário durante a configuração do parâmetro do Webhook.
• Limites para Webhooks:
• Edição Professional - 10000 chamadas/dia ou 100 chamadas/licença de usuário (o que for menor).
• Edição Enterprise - 20000 chamadas/dia ou 500 chamadas/licença de usuário (o que for menor).

Cenário de negócios 1

Calcule a comissão de vendas no aplicativo Zoho Creator após o fechamento de uma oportunidade no Zoho CRM.

Finalidade

Os gerentes de vendas e a equipe de folha de pagamento podem usar o aplicativo de comissão de vendas para calcular a remuneração de seus representantes de vendas de acordo com uma fórmula pré-definida configurada por sua organização (por exemplo, 2% do contrato fechado ou do valor de vendas). Esse 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 acompanhar suas comissões mensais em um local central.

Pré-requisito

• Conta no aplicativo Zoho Creator
• Permissão para acessar o Zoho API
• Familiaridade com o Zoho Creator

Procedimento

1. Crie o aplicativo de comissão de vendas no Zoho Creator (consulte o tutorial do Zoho Creator em Criação de aplicativos)
2. Configurar o Webhook no Zoho CRM
3. Configurar a regra de fluxo de trabalho
4. Testar sua integração Webhook

Etapa 1: criar aplicativo de comissões de vendas no Zoho Creator

No Zoho Creator, crie o aplicativo de comissão de vendas com os seguintes campos:

• Representante de vendas
• Nome da negociação
• Nome do cliente
• Valor da oportunidade
• Tipo de negócios: negócios novos ou existentes
• Data de fechamento
• Comissão de vendas

Para criar um aplicativo no Zoho Creator, consulte a ajuda on-line

Etapa 2: configurar Webhook

Selecione os seguintes campos pelo módulo Negociação ao configurar os parâmetros definidos pelo usuário:

• Nome da negociação
• Data de fechamento
• Tipo
• Proprietário do registro
• Valor

No Webhook, especifique os detalhes a seguir:

URL para notificar:

1. https://creator.zoho.com/api/xml/write - Método POST

Parâmetros definidos pelo usuário (XML ou JSON)

Parâmetros personalizados:

Parâmetro	Descrição
authtoken*	Especifique o token de autenticação pela sua conta do Creator. Consulte a Ajuda do Creator para obter mais detalhes.
zc_ownername*	Especifique o nome do proprietário do aplicativo da sua conta do Creator.

Etapa 3: configurar a regra de fluxo de trabalho

Siga essas etapas na página Regra de Fluxo de Trabalho:

1. Configure os critérios de fluxo de trabalho como:
   • O tipo é Novos Negócios
   • O estágio é Fechamento Conquistado
2. Clique em Avançar.
   
3. Selecione webhook como a ação instantânea.
4. Na janela pop-up Chamar Webhook, selecione o webhook necessário na lista e clique em Associar.
5. Salve a regra de fluxo de trabalho.

 

Associar o Webhook a uma regra de fluxo de trabalho

Etapa 4: testar a integração

1. Adicione uma negociação de teste no CRM com os campos Tipo e Estágio como Novos Negócios e Fechamento Conquistado, respectivamente. Durante a inserção de dados de teste, verifique se também foram inseridos os dados para Valor, Dados de Fechamento, Proprietário do Registro, Nome da Conta e Nome da Negociação.
2. Abra o aplicativo de comissão de vendas no Zoho Creator e verifique os dados do CRM. 
   Se nenhum dado for recebido, modifique a configuração do webhook e continue o teste. Após os testes serem bem-sucedidos, remova as entradas de teste e implante essa integração aos usuários do CRM.

Cenário de negócios 2

Envie alertas por SMS para clientes e representantes de vendas.

Finalidade

Um pagamento de um cliente deve ser feito hoje. Você pode enviar um SMS com a data de vencimento do pagamento, o nome do cliente e a quantidade de detalhes para o 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 de SMS
• Permissão para acessar regras de fluxo de trabalho

Procedimento

1. Criar uma conta no serviço de gateway de SMS
2. Configurar o Webhook no Zoho CRM
3. Configurar a regra de fluxo de trabalho
4. Testar sua integração Webhook

Etapa 1: criar uma conta no serviço de gateway de SMS

Em seu serviço de gateway de SMS, crie uma conta e obtenha esses detalhes para configurar o webhook:

• Representante de vendas
• Nome da negociação
• Nome do cliente
• Valor da oportunidade
• Tipo de Negócios: Novos Negócios
• Estágio: Fechamento Conquistado
• Data de Vencimento do Pagamento (campo personalizado)

Atualmente a Zoho tem parceria com os seguintes provedores de gateway de SMS:

• SMS em massa
• Clickatell
• Screen Magic
• Valueleaf
• Soluções Infini

Você pode comprar créditos de SMS e detalhes de API nos fornecedores acima.

Etapa 2: configurar Webhook

Selecione os seguintes campos pelo módulo Oportunidades ao configurar os parâmetros definidos pelo usuário:

• Nome de domínio do gateway de SMS
• Nome de usuário
• Token de autenticação

No webhook, especifique os detalhes a seguir:

URL para notificar:

1. http://<Domain Nome>/smsgateway/post - método POST

Parâmetros definidos pelo usuário (XML ou JSON)

Etapa 3: configurar a regra de fluxo de trabalho

Siga essas etapas na página Regra de Fluxo de Trabalho:

1. Configure os critérios de fluxo de trabalho como:
   • O tipo é Novos Negócios.
   • O estágio é Fechamento Conquistado.
   • Escolha a data de fechamento.
2. Selecione o webhook como uma ação baseada em tempo.
3. Salve a regra de fluxo de trabalho.

Critérios da regra de fluxo de trabalho

Associar o Webhook a uma regra de fluxo de trabalho

Etapa 4: testar a integração

1. Adicione uma negociação de teste no CRM com os campos Tipo e Data de Vencimento do Pagamento como Negócios Existentes e Hoje, respectivamente. Durante a inserção de dados de teste, verifique se também foram inseridos os dados para Valor, Dados de Fechamento, Proprietário do Registro, Nome da Conta e Nome da Negociação.
2. No telefone móvel, verifique o alerta de SMS
   Se nenhum SMS for recebido, modifique a configuração do webhook e continue o teste. Após os testes serem bem-sucedidos, remova as entradas de teste e implante essa integração aos usuários do CRM.

---

Consultar códigos de erro

Quando a execução do webhook falhar, uma das seguintes mensagens de erro serão exibidas no Zoho CRM:

Códigos de status HTTP

• 400 Solicitação Inválida - geralmente a ausência de um parâmetro necessário.
• 401 Não Autorizado - nenhum token de autenticação válido foi fornecido.
• 402 Falha na Solicitação - parâmetros válidos, mas falha na solicitação.
• 404 Não Encontrado - o item solicitado não existe.
• 500, 502, 503, 504 Erros de servidor - algo deu errado no aplicativo de terceiros.
• Código de Erro 1 - não é possível conectar temporariamente ao servidor da API. É necessário verificar os registros do servidor de API, as configurações de firewalls para nossas solicitações enviadas do CRM.

Erros personalizados

• Falha de processo interno - quando o webhook não é executado devido a erros no processamento do webhook.
• Limite do dia atingido - quando a empresa alcançou o limite máximo do dia.
• Quando o webhook não é executado devido ao URL estar vulnerável a SSRF ou a um URL inválido.