Como conectar o Sentry ao Shopify Flow
O Sentry pode notificar uma integração quando um problema é criado, atribuído, resolvido ou quando um alerta é acionado. 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 - o Sentry envia, Workflow Webhooks recebe e verifica, Shopify Flow executa - com a assinatura HMAC do Sentry verificada em cada solicitação, de modo que somente o Sentry possa iniciar seu fluxo de trabalho.
O que o(a) senhor(a) pode construir
- Envie um e-mail para a pessoa de plantão, incluindo informações sobre a loja, sempre que ocorrer um pico de erros no processo de checkout.
- Insira a data e hora do último incidente em um metacampo da loja que seu tema possa ler.
- Inicie um Shopify Flow que suspenda uma promoção quando um alerta crítico for acionado.
Eventos típicos a serem enviados: uma solicitação é criada, uma regra de alerta é acionada, uma solicitação é resolvida.
Antes de começar
- Workflow Webhooks instalado em sua loja do Shopify.
- Shopify Flow instalado, que está disponível gratuitamente na App Store do Shopify.
- Uma conta no Sentry com permissão para criar webhooks.
Etapa 1 - Crie o webhook em Workflow Webhooks
- Acesse Workflow Webhooks -> Webhooks -> Criar webhook e atribua a ele um nome que você reconheça no Shopify Flow, como
Sentry events. - Na seção “Autenticação”, selecione HMAC.
- Em “Provedor de assinatura”, selecione o Sentry. 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 configurar.
- 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 Sentry
No Sentry, abra seu aplicativo da Plataforma de Integração, defina a URL do webhook como a URL que você copiou, habilite os eventos desejados e copie o segredo do cliente.
Como localizar seu segredo de assinatura do Sentry
O segredo do cliente da sua integração com o Sentry.
A própria documentação do Sentry sobre assinaturas de webhooks contém o texto exato e as capturas de tela referentes à sua conta.
Cole essa chave secreta no campo “Secret” do webhook em Workflow Webhooks e salve. A partir desse momento, todas as notificações do Sentry serão verificadas antes de chegarem ao Shopify Flow.
O que isso verifica
| O que | Valor |
|---|---|
| Cabeçalho de assinatura | Sentry-Hook-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} corresponde ao corpo bruto da solicitação, byte por 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
- No “Shopify Flow”, crie um fluxo de trabalho e selecione o gatilho “Workflow Webhooks”.
- Clique em “Gravar eventos” e, em seguida, envie um evento de teste pelo Sentry (ou utilize a opção “Enviar teste” no Workflow Webhooks) para que o Shopify Flow aprenda a estrutura dos seus dados.
- 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 seja direcionado exclusivamente ao Sentry. O ID é exibido na página do webhook.
- Adicione suas ações - tag um cliente, adicione uma nota, envie um e-mail interno, atualize um metacampo.
Etapa 4 - Teste de ponta a ponta
Gatilho para um evento real no Sentry. 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 assinaturas, que mostra exatamente em qual etapa ocorreu a falha.
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 Sentry 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 Sentry selecionado, se o segredo está preenchido e se o Sentry 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 chegou. Verifique novamente a URL no Sentry e consulte o próprio registro de entrega do Sentry 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 do Sentry.
Relacionado
- Verificação de webhooks assinados - todos os prestadores de serviços que verificamos e como descrever aqueles que não verificamos.
- Mapeamento de payload e variáveis de fluxo - extrair os campos corretos da payload e inseri-los no Shopify Flow.
- Proteção contra entregas duplicadas - o que ocorre quando o Sentry tenta novamente uma entrega.
- Histórico e solução de problemas - o registro de todas as solicitações, com reprodução.