Como ligar o Svix a umShopify Flow
A Svix é a infraestrutura de webhooks subjacente ao Clerk, ao Resend, ao Superwall e a muitos outros produtos. Se o seu remetente efetuar entregas através do Svix, esta predefinição verifica essa informação. O «Workflow Webhooks» transforma essa chamada num gatilho «Shopify Flow», para que a 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 processo - o Svix envia, o Workflow Webhooks recebe e verifica, e o Shopify Flow executa - com a assinatura HMAC do Svix verificada em cada pedido, pelo que apenas o Svix pode iniciar o seu fluxo de trabalho.
O que pode construir
- Assinale um cliente do Shopify quando o Clerk indicar que este se registou ou verificou o seu endereço de e-mail na sua aplicação.
- Reaja a um evento de reenvio ou de devolução e assinale o cliente cuja morada apresenta problemas.
- Receba mensagens de qualquer produto com tecnologia Svix sem ter de configurar uma assinatura personalizada.
Eventos típicos a enviar: qualquer evento definido pelo serviço de envio.
A mesma configuração pré-definida verifica também os webhooks do Clerk, do Resend e do Superwall.
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 Svix 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
Svix events. - Na secção «Autenticação», selecione HMAC.
- Na secção «Fornecedor de assinatura», selecione «Svix». 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 Svix
Adicione o URL como ponto final nas definições do webhook do serviço de envio e, em seguida, revele e copie o seu segredo de assinatura (que começa por whsec_).
Como encontrar o seu segredo de assinatura Svix
O segredo de assinatura do ponto final que começa por «whsec_», proveniente das definições do webhook do serviço.
A documentação da própria Svix sobre assinaturas de webhooks, disponível em, contém o texto exato e as capturas de ecrã relativas à sua conta.
Cole essa chave secreta no campo «Secret» do webhook em Workflow Webhooks e guarde. A partir desse momento, todas as entregas do Svix serão verificadas antes de chegarem ao Shopify Flow.
O que isto verifica
| O que | Valor |
|---|---|
| Cabeçalho da assinatura | svix-signature |
| Onde se encontra a assinatura | O valor do cabeçalho, após o prefixo v1, |
| O que foi assinado | {header:svix-id}.{timestamp}.{body} |
| Assinatura | HMAC-SHA256, codificado em base64 |
| Data e hora | O cabeçalho svix-timestamp, em segundos Unix |
| Proteção contra reprodução | Os pedidos cujo carimbo temporal assinado se situe a mais de 5 minutos do momento atual são rejeitados |
| O segredo | Decodificado em Base64 antes da utilização. O whsec_ inicial é removido antes da decodificação. Cole-o exatamente como o remetente o apresenta |
Na payload assinada, {body} corresponde ao corpo da solicitação em formato bruto, byte a byte; {timestamp} corresponde ao carimbo temporal acima; e {header:svix-id} corresponde ao cabeçalho da solicitação svix-id.
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 Svix (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 dispõe aciona o mesmo gatilho do Shopify Flow; por isso, adicione uma primeira condição com base no ID do webhook para que este fluxo de trabalho se aplique apenas ao Svix. 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
Aceda um evento real no Svix. Em «Workflow Webhooks» → «History», deverá ver a invocação com o estado «Success». Se a assinatura estiver incorreta, será apresentada uma entrada com o estado «Failed» e o motivo correspondente; em Verificação de webhooks assinados encontra explicações sobre o verificador de assinaturas, que lhe indica 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 Svix e a aplicação reescreve o corpo da mensagem. As assinaturas abrangem os bytes em bruto, pelo que 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 todos os pedidos▾
Verifique se a autenticação do webhook está definida como HMAC com o fornecedor Svix selecionado, se o segredo está preenchido e se o Svix 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 Svix e consulte o registo de entrega do próprio Svix 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 relativa ao ID do webhook como primeiro passo do fluxo de trabalho ou restrinja os eventos que envia a partir do Svix.
Os pedidos falham com a mensagem «carimbo temporal fora da tolerância»▾
O Svix assina um carimbo de data/hora e a aplicação rejeita qualquer mensagem com mais de 5 minutos. Normalmente, trata-se de um problema de relógio no lado do remetente ou de uma entrega que o Svix voltou a tentar muito mais tarde com o carimbo de data/hora original. As novas tentativas decorrentes da mesma solicitação original não podem ser aceites; solicite ao Svix que envie um evento novo.
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 Svix tenta novamente efetuar uma entrega.
- Histórico e resolução de problemas - o registo de cada pedido, com reprodução.