Como ligar o GitHub a umShopify Flow
O GitHub envia um Webhook sempre que ocorre alguma ação num repositório ou numa organização - um push, um lançamento, uma issue, um pedido de integração ou a execução de um fluxo de trabalho. O Workflow Webhooks transforma essa chamada num gatilho do Shopify Flow, para que a sua loja possa reagir a ela: marcar um cliente, adicionar uma nota à encomenda, enviar um e-mail interno, atualizar um Metacampo - tudo o que o Shopify Flow permite fazer.
Este guia define todo o processo - o GitHub envia, Workflow Webhooks recebe e verifica, Shopify Flow executa - com a assinatura HMAC do GitHub verificada em cada pedido, pelo que apenas o GitHub pode iniciar o seu fluxo de trabalho.
O que pode construir
- Envie um e-mail à sua equipa de merchandising sempre que for lançada uma atualização que altere os dados dos produtos.
- Em cada lançamento, introduza a versão atual da compilação ou do tema num metacampo da loja.
- Alerte a equipa quando uma execução programada do fluxo de trabalho falhar, utilizando o mesmo fluxo de trabalho que já utiliza para outros incidentes.
Eventos típicos a enviar: push, release (publicado), issues (aberto, encerrado), workflow_run (concluído).
Antes de começar
- Workflow Webhooks instalado na sua loja Shopify.
- Shopify Flow instalada, que está disponível gratuitamente na App Store da Shopify.
- Uma conta no GitHub com permissão para criar webhooks.
Passo 1 - Crie o webhook em Workflow Webhooks
- Aceda a Workflow Webhooks -> Webhooks -> Criar webhook e atribua-lhe um nome que consiga reconhecer no Shopify Flow, como, por exemplo,
GitHub events. - Na secção «Autenticação», selecione HMAC.
- Na secção «Provedor de assinatura», selecione GitHub. A aplicação preenche automaticamente o cabeçalho, o algoritmo, o payload assinado e a janela de repetição - não há mais nada a configurar.
- Por enquanto, deixe o campo «segredo» em branco e clique em «Guardar». Copie o URL do webhook apresentado na página.
Consulte Autenticação para conhecer os outros modos de autenticação e Mapeamento da carga útil e variáveis de fluxo para saber como escolher quais os campos que são enviados ao Shopify Flow.
Passo 2 - Adicione o ponto final no GitHub
No repositório (ou organização), abra «Definições» -> «Webhooks» -> «Adicionar Webhook», cole o URL no campo «URL do Payload», defina o tipo de conteúdo como application/json e preencha o campo «Segredo».
Como encontrar o seu segredo de assinatura do GitHub
O segredo que definiu no webhook do GitHub (Definições -> Webhooks -> Segredo).
A própria documentação do GitHub sobre assinaturas de webhooks contém o texto exato e as capturas de ecrã relativas à sua conta.
Cole esse segredo no campo «Secret» do webhook em Workflow Webhooks e guarde. A partir desse momento, todas as entregas do GitHub serão verificadas antes de chegarem ao Shopify Flow.
O que isto verifica
| O quê | Valor |
|---|---|
| Cabeçalho da assinatura | X-Hub-Signature-256 |
| Onde se encontra a assinatura | O valor do cabeçalho, após o prefixo sha256= |
| 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 - este remetente não assina o carimbo temporal, pelo que todas as assinaturas válidas permanecem válidas |
| O segredo | Utilizado como texto simples. Cole-o exatamente tal como o remetente o apresenta |
Na payload assinada, {body} corresponde ao corpo da solicitação em formato bruto, byte a byte.
Um pedido que não cumpra qualquer um destes requisitos é rejeitado com o erro 401, é registado em Histórico e resolução de problemas e nunca dá início a um fluxo de trabalho.
Passo 3 - Criar o fluxo de trabalho Shopify Flow
- No «Shopify Flow», crie um fluxo de trabalho e selecione o gatilho «Workflow Webhooks».
- Clique em «Registar eventos» e, em seguida, envie um evento de teste a partir do GitHub (ou utilize a opção «Enviar teste» em Workflow Webhooks) para que o Shopify Flow aprenda a estrutura dos seus dados.
- Cada webhook de que dispõe aciona o mesmo gatilho do Flow; por isso, adicione uma primeira condição com base no ID do webhook para que este fluxo de trabalho se limite apenas ao GitHub. O ID é apresentado na página do webhook.
- Adicione as suas ações - identifique um cliente, adicione uma nota, envie um e-mail interno, atualize um metacampo.
Passo 4 - Teste-o de ponta a ponta
Aqueça um evento real no GitHub. Em Workflow Webhooks -> Histórico, deverá ver a invocação com o estado «Sucesso». Se a assinatura estiver incorreta, será apresentada uma entrada com o estado «Falha» e o motivo correspondente; em Verificação de webhooks assinados, é explicada a ferramenta de verificação de assinaturas, que lhe mostra exatamente em que etapa ocorreu a falha.
A assinatura não corresponde▾
Por este pedido: o segredo (a causa mais comum - um espaço a mais ou uma chave do ambiente errado), se o remetente está a utilizar o segredo de um ponto final diferente e se algo entre o GitHub e a aplicação reescreve o corpo da mensagem. As assinaturas abrangem os bytes brutos, pelo que um proxy que reformate 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 todos os pedidos▾
Verifique se a autenticação do webhook está definida como HMAC com o fornecedor GitHub selecionado, se o segredo está preenchido e se o GitHub está a enviar dados para o URL exatamente como o aplicativo o apresenta, incluindo o código no final.
Não aparece nada no Histórico▾
O pedido nunca chegou. Verifique novamente o URL no GitHub e consulte o próprio registo de entrega do GitHub para ver a resposta que recebeu. Um erro 404 significa que o webhook está incorreto ou foi eliminado; um erro 429 significa que ultrapassou o limite de invocações do seu plano - consulte Planos e utilização.
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 primeiro passo do fluxo de trabalho ou restrinja os eventos que envia a partir do GitHub.
Relacionado
- Verificação de webhooks assinados - todos os prestadores que verificamos e como descrever aqueles que não verificamos.
- Mapeamento da carga útil e variáveis de fluxo - extrair os campos corretos da payload e transferi-los para o Shopify Flow.
- Proteção contra entregas duplicadas - o que acontece quando o GitHub tenta novamente efetuar uma entrega.
- Histórico e resolução de problemas - o registo de cada pedido, com reprodução.