Como conectar o Zendesk ao Shopify Flow

O Zendesk pode acionar um Webhook a partir de um gatilho ou de uma automação sempre que houver uma alteração em um ticket. O Workflow Webhooks transforma essa chamada em um gatilho do Shopify Flow, para que sua loja possa reagir a ela: marcar um cliente, adicionar uma nota ao pedido, enviar um e-mail interno, atualizar um metacampo - tudo o que o Shopify Flow pode fazer.

Este guia define todo o fluxo de trabalho - o Zendesk envia, Workflow Webhooks recebe e verifica, Shopify Flow executa - com a assinatura HMAC do Zendesk verificada em cada solicitação, de modo que somente o Zendesk possa iniciar seu fluxo de trabalho.

O que o senhor pode construir

  • Marque o cliente Shopify associado a um ticket que foi encaminhado para um nível superior, para que sua equipe o veja no painel de administração.
  • Adicione uma observação ao pedido quando um ticket de suporte relacionado a esse pedido for resolvido.
  • Envie um e-mail a um gerente quando um cliente de alto valor atribuir uma nota baixa de satisfação.

Eventos típicos a serem enviados: é criado um ticket, um ticket é resolvido, é recebida uma avaliação de satisfação.

Antes de começar

  • Workflow Webhooks instalado na sua loja do Shopify.
  • Shopify Flow instalado, que está disponível gratuitamente na App Store do Shopify.
  • Uma conta no Zendesk com permissão para criar webhooks.

Etapa 1 - Crie o webhook em Workflow Webhooks

  1. Acesse Workflow Webhooks -> Webhooks -> Criar webhook e atribua a ele um nome que você reconheça no Shopify Flow, como Zendesk events.
  2. Na seção “Autenticação”, selecione HMAC.
  3. Em “Provedor de assinatura”, selecione Zendesk. O aplicativo preenche automaticamente o cabeçalho, o algoritmo, o payload assinado e a janela de repetição para você - não há mais nada a ser configurado.
  4. Deixe o campo “segredo” em branco por enquanto e clique em “Salvar”. Copie a URL da webhook exibida na página.

Consulte Autenticação para conhecer os outros modos de autenticação e Mapeamento de payload e variáveis de fluxo para escolher quais campos serão enviados para Shopify Flow.

Etapa 2 - Adicione o endpoint no Zendesk

No Centro de Administração do Zendesk, abra Aplicativos e integrações -> Webhooks, crie um webhook apontando para a URL que o(a) senhor(a) copiou, conecte-o a um gatilho e, em seguida, utilize a opção “Revelar segredo”.

Como localizar seu segredo de assinatura do Zendesk

O segredo de assinatura do webhook (Centro de Administração -> Aplicativos e integrações -> Webhooks -> Revelar segredo).

A própria documentação da Zendesk sobre assinaturas de webhooks, disponível em, contém o texto exato e as capturas de tela específicas para a sua conta.

Cole esse segredo no campo “Secret” do webhook em Workflow Webhooks e salve. A partir desse momento, todas as notificações do Zendesk serão verificadas antes de chegarem ao Shopify Flow.

O que isso verifica

O que Valor
Cabeçalho de assinatura X-Zendesk-Webhook-Signature
Onde fica a assinatura O valor completo do cabeçalho
O que foi assinado {header:x-zendesk-webhook-signature-timestamp}{body}
Assinatura HMAC-SHA256, codificado em base64
Data e hora Não é utilizado por este remetente
Proteção contra reprodução Nenhuma - esse remetente não assina o carimbo de data e hora; portanto, todas as assinaturas válidas permanecem válidas
O segredo Utilizado como texto simples. Cole-o exatamente como o remetente o apresenta

Na payload assinada, {body} é o corpo bruto da solicitação, byte por byte, e {header:x-zendesk-webhook-signature-timestamp} é o cabeçalho da solicitação x-zendesk-webhook-signature-timestamp.

Uma solicitação que não atenda a qualquer um desses requisitos é rejeitada com o código de erro 401, é registrada em Histórico e solução de problemas e nunca inicia um fluxo de trabalho.

Etapa 3 - Crie o fluxo de trabalho Shopify Flow

  1. No “Shopify Flow”, crie um fluxo de trabalho e selecione o gatilho “Workflow Webhooks”.
  2. Clique em “Gravar eventos” e, em seguida, envie um evento de teste a partir do Zendesk (ou use a opção “Enviar teste” em Workflow Webhooks) para que o Shopify Flow aprenda o formato dos seus dados.
  3. Cada webhook de que o senhor dispõe aciona o mesmo gatilho do Flow; portanto, adicione uma primeira condição com base no ID do webhook para limitar esse fluxo de trabalho exclusivamente ao Zendesk. O ID é exibido na página do webhook.
  4. Adicione suas ações - marque um cliente, adicione uma nota, envie um e-mail interno, atualize um metacampo.
Shopify Flow
Em Shopify Flow, selecione “Selecionar um gatilho”, acesse Workflow Webhooks e escolha “Gatilho de Webhook”.
Condição do Shopify Flow: o ID do webhook é igual ao ID de um webhook
O primeiro passo de todo fluxo de trabalho: uma condição relacionada ao ID do webhook, para que o fluxo de trabalho seja executado apenas para esse webhook.
O fluxo de trabalho finalizado: Gatilho de webhook, uma condição baseada no ID do webhook e, em seguida, o envio de um e-mail interno na ramificação “Verdadeiro”
O fluxo de trabalho finalizado: gatilho, condição baseada no ID do webhook e, em seguida, sua ação no ramo “True”.

Etapa 4 - Teste de ponta a ponta

Gatilho para um evento real no Zendesk. Em Workflow Webhooks -> Histórico, vocês deverão ver a invocação com o status “Sucesso”. Caso a assinatura esteja incorreta, será exibida uma entrada com status de falha e o motivo correspondente; além disso, Verificação de webhooks assinados explica como funciona o verificador de assinatura, que mostra exatamente em qual etapa ocorreu a falha.

Uma invocação foi aberta no History com seus cabeçalhos de solicitação, payload, status, duração e identificadores
Um evento registrado no History com o status “Sucesso” significa que Shopify Flow o aceitou.
A assinatura não corresponde▾

Nesta ordem: o segredo (a causa mais comum - um espaço a mais ou uma chave do ambiente errado), se o remetente está utilizando o segredo de um endpoint diferente e se algo entre o Zendesk e o aplicativo reescreve o corpo da mensagem. As assinaturas abrangem os bytes brutos; portanto, um proxy que reformata o JSON as invalida. O verificador de assinaturas na página do webhook mostra o texto exato que foi assinado.

Recebo um erro 401 em todas as solicitações▾

Verifique se a autenticação do webhook está configurada como HMAC com o provedor Zendesk selecionado, se o segredo está preenchido e se o Zendesk está enviando dados para a URL exatamente como o aplicativo a exibe, incluindo o código no final.

Não há nada no Histórico▾

A solicitação nunca foi recebida. Verifique novamente a URL no Zendesk e consulte o próprio registro de entrega do Zendesk para verificar a resposta recebida. Um erro do tipo 404 indica um webhook incorreto ou excluído; um erro do tipo 429 significa que você ultrapassou o limite de invocações do seu plano - consulte Planos e uso.

O fluxo de trabalho é executado para os eventos errados▾

Cada webhook da sua loja aciona o mesmo gatilho do Flow. Adicione uma condição com base no ID do webhook como primeira etapa do fluxo de trabalho ou restrinja os eventos que você envia do Zendesk.

Relacionado