Como conectar o Linear ao Shopify Flow

O Linear envia um Webhook sempre que houver alterações em tickets, projetos ou comentários em seu espaço de trabalho. 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 - a Linear envia, Workflow Webhooks recebe e verifica, Shopify Flow executa - com a assinatura HMAC da Linear verificada em cada solicitação, de modo que somente a Linear possa iniciar seu fluxo de trabalho.

O que o(a) senhor(a) pode construir

  • Envie um e-mail para sua equipe de merchandising quando um bug marcado com a tag storefront atingir o status “Concluído”.
  • Insira o número do sprint ou da versão atual em um metacampo da loja.
  • Inicie um fluxo de trabalho com lista de verificação do lado da loja quando um problema de lançamento for encerrado.

Eventos típicos a serem enviados: é criado um ticket ou ele muda de estado, é adicionado um comentário, é publicada uma atualização do projeto.

Antes de começar

  • Workflow Webhooks instalado na sua loja do Shopify.
  • Shopify Flow instalado, que pode ser baixado gratuitamente na App Store da Shopify.
  • Uma conta no Linear 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 Linear events.
  2. Na seção “Autenticação”, selecione HMAC.
  3. Em “Provedor de assinatura”, selecione “Linear”. 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 ao Shopify Flow.

Etapa 2 - Adicione o endpoint no Linear

No Linear, abra Configurações -> API -> Webhooks, crie um webhook com a URL que você copiou e copie o segredo de assinatura exibido ali.

Como encontrar seu segredo de assinatura linear

O segredo de assinatura exibido no webhook no Linear (Configurações -> API -> Webhooks).

A própria documentação da Linear sobre assinaturas de webhooks contém o texto exato e as capturas de tela referentes à sua conta.

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

O que isso verifica

O que Valor
Cabeçalho de assinatura Linear-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

No payload assinado, {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 - Criar o fluxo de trabalho Shopify Flow

  1. No “Shopify Flow”, crie um fluxo de trabalho e selecione o gatilho “Workflow Webhooks”.
  2. Clique em “Registrar eventos” e, em seguida, envie um evento de teste a partir do Linear (ou utilize a opção “Enviar teste” no Workflow Webhooks) para que o Shopify Flow aprenda o padrão dos seus dados.
  3. Cada webhook de que o senhor dispõe aciona o mesmo gatilho do Shopify Flow; portanto, adicione uma primeira condição com base no ID do webhook para que esse fluxo de trabalho se aplique apenas ao Linear. 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 com base no ID do webhook e, em seguida, sua ação no ramo “Verdadeiro”.

Etapa 4 - Teste de ponta a ponta

Gatilho de evento real no Linear. Em “Workflow Webhooks” → “History”, o(a) senhor(a) deverá visualizar a invocação com o status “Success”. Caso a assinatura esteja incorreta, será exibida uma entrada com status de falha e o motivo correspondente; a página Verificação de webhooks assinados explica como funciona o verificador de assinaturas, que indica 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▾

Nesse pedido: 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 Linear 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 Linear selecionado, se o segredo está preenchido e se o Linear está enviando a solicitação 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 Linear e consulte o próprio registro de entrega do Linear 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 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 do Linear.

Relacionado