Como ligar o Sanity ao Shopify Flow
O Sanity envia um Webhook com tecnologia GROQ sempre que for criado, atualizado ou eliminado conteúdo que corresponda à sua pesquisa. O Workflow Webhooks transforma essa chamada num gatilho do Shopify Flow, para que a sua loja possa reagir a ela: atribuir uma Tag a um cliente, adicionar uma nota ao pedido, enviar um e-mail interno, atualizar um metacampo - tudo o que o Shopify Flow permite fazer.
Este guia define todo o processo - a Sanity envia, Workflow Webhooks recebe e verifica, Shopify Flow executa - com a assinatura HMAC da Sanity verificada em cada pedido, pelo que apenas a Sanity pode iniciar o seu fluxo de trabalho.
O que pode construir
- Atualize um metacampo Shopify sempre que a entrada correspondente no CMS for alterada, para que a loja virtual se mantenha em sintonia.
- Envie um e-mail à sua equipa de merchandising quando for publicada uma página de destino.
- Inicie um fluxo de trabalho de atualização da cache após a publicação de conteúdos.
Eventos típicos a enviar: a publicação de um documento, a atualização de um documento, a eliminação de um documento.
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 Sanity 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,
Sanity events. - Na secção «Autenticação», selecione HMAC.
- Na secção «Fornecedor de assinatura», selecione «Sanity». A aplicação preenche automaticamente o cabeçalho, o algoritmo, o payload assinado e a janela de repetição - não é necessário configurar mais nada.
- 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 Sanity
No Sanity, aceda a API -> Webhooks, crie um webhook baseado no GROQ com o URL que copiou e defina o segredo.
Como encontrar o seu segredo de assinatura do Sanity
A configuração do Secret no webhook baseado no GROQ.
A própria documentação da Sanity sobre assinaturas de webhooks, disponível em, 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 Sanity serão verificadas antes de chegarem ao Shopify Flow.
O que isto verifica
| O quê | Valor |
|---|---|
| Cabeçalho da assinatura | sanity-webhook-signature |
| Onde se encontra a assinatura | No valor v1 desse cabeçalho, que contém pares key=value separados por vírgulas |
| O que foi assinado | {timestamp}.{body} |
| Assinatura | HMAC-SHA256, codificado em base64url |
| Data e hora | O valor t do cabeçalho da assinatura, expresso em milissegundos do Unix |
| 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 carga útil assinada, {body} corresponde ao corpo da solicitação em formato bruto, byte a byte, e {timestamp} corresponde ao carimbo temporal acima.
Um pedido que não cumpra qualquer um destes requisitos é rejeitado com o código de 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 Sanity (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 Shopify Flow; por isso, adicione uma primeira condição com base no ID do webhook, para que este fluxo de trabalho se limite exclusivamente ao Sanity. 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 Sanity. 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, encontra explicações sobre o verificador 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 Sanity e a aplicação reescreve o corpo da mensagem. As assinaturas abrangem os bytes brutos, 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 Sanity selecionado, se o segredo está preenchido e se o Sanity 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 Sanity e consulte o registo de entrega do próprio Sanity 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 Sanity.
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 Sanity volta a tentar efetuar uma entrega.
- Histórico e resolução de problemas - o registo de cada pedido, com reprodução.