Como conectar o Sendcloud ao Shopify Flow

A Sendcloud cuida do envio e do rastreamento de encomendas. Ela envia um Webhook sempre que o status de uma encomenda é alterado. 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 - a Sendcloud envia, o Workflow Webhooks recebe e verifica, e o Shopify Flow executa - com a assinatura HMAC da Sendcloud verificada em cada solicitação, de modo que somente a Sendcloud possa iniciar seu fluxo de trabalho.

O que o senhor pode construir

  • Adicione uma nota ao pedido no momento em que a encomenda for entregue, sem precisar consultar a API da transportadora.
  • Envie um e-mail ao representante designado para o cliente quando uma entrega não for bem-sucedida.
  • Marque os pedidos que estão retidos em trânsito por mais tempo do que o esperado, para que a equipe de suporte possa tomar as medidas necessárias.

Eventos típicos a serem enviados: uma encomenda é anunciada, uma encomenda está em trânsito, uma encomenda é entregue, uma entrega falha.

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 Sendcloud 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 Sendcloud events.
  2. Na seção “Autenticação”, selecione HMAC.
  3. Em “Provedor de assinatura”, selecione Sendcloud. 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 do 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 ao Shopify Flow.

Etapa 2 - Adicione o endpoint no Sendcloud

No Sendcloud, abra as configurações da integração e defina a URL do webhook como a URL que você copiou. A chave secreta da integração é o que autentica a solicitação.

Como localizar seu segredo de assinatura do Sendcloud

A chave secreta da integração (ou a chave de assinatura do webhook).

A documentação da própria Sendcloud sobre assinaturas de webhooks 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 entregas do Sendcloud serão verificadas antes de chegarem ao Shopify Flow.

O que isso verifica

O que Valor
Cabeçalho de assinatura Sendcloud-Signature
Onde fica a assinatura O valor completo do cabeçalho
O que foi assinado {body}
Assinatura HMAC-SHA256, codificado em hexadecimal
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 da solicitação em formato bruto, byte a byte.

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 pelo Sendcloud (ou utilize a opção “Enviar teste” no site 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 restringir esse fluxo de trabalho exclusivamente ao Sendcloud. 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 baseada no 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 no ramo “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

Acionem um evento real no Sendcloud. 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 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 Sendcloud 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 Sendcloud selecionado, se o segredo está preenchido e se o Sendcloud está enviando para a URL exatamente como o aplicativo a exibe, incluindo o código no final.

Não há nada no Histórico▾

Uma solicitação nunca chegou. Verifique novamente a URL no Sendcloud e consulte o próprio registro de entrega do Sendcloud para ver 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 Shopify 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 pelo Sendcloud.

Relacionado