Crie seu primeiro webhook

Este guia o conduz desde um aplicativo vazio até um fluxo de trabalho do Shopify Flow que é executado quando o seu próprio sistema assim o determinar. Cerca de dez minutos.

1. Criar um webhook

Webhooks -> Criar webhook. A página pergunta, em primeiro lugar, o que acionará esse webhook e configura-o de forma a corresponder a isso:

Sua resposta	O que você recebe
Uma ferramenta de automação (n8n, Make, Zapier, seu próprio código)	Um token gerado, pronto para ser colado na ferramenta
Um serviço que assina seus webhooks (Stripe, GitHub, ...)	Verificação de assinatura para o serviço que o(a) senhor(a) escolher - consulte Verificação de webhooks assinados
Um script para navegador ou loja virtual	CORS ativado - consulte CORS, a URL do proxy do aplicativo e as chamadas do navegador
Nada - execute-o de acordo com uma programação	A webhook que acessa uma URL em intervalos programados; a aba “Agendamento” é exibida em seguida - consulte Verificação programada de URLs
Outra opção, ou decidir mais tarde	O senhor mesmo escolhe o método de autenticação

Dê a ele um nome que você reconheça mais tarde (“Lembrete do cartão de carteira”, “Formulário de contato”) e salve. Todas as configurações podem ser alteradas posteriormente.

Agora o senhor possui uma URL de webhook que termina com um código curto, por exemplo, https://.../webhook/ab12cd34. Essa URL é o endpoint para o qual o seu sistema envia uma solicitação POST.

Na página “Criar webhook”, na qual é perguntado “O que acionará este webhook?”, com a opção “Nada - executar em horário programado” selecionada e uma observação de que a guia “Programação” será aberta em seguida — A criação de um webhook começa com a definição de quem irá acioná-lo. A resposta configura a autenticação correspondente; a opção “Nada - executar em horário programado” abre a guia “Agendamento” em seguida.

O editor de webhooks: nome e autenticação à esquerda; o cartão “Endpoint”, com status, URL do webhook e ID do webhook, à direita; acima, as opções “Visualização ao vivo”, “Teste” e “Uso” — O editor de webhooks. As configurações estão à esquerda; o cartão “Endpoint”, à direita, contém a URL do webhook a ser fornecida ao remetente e o ID do webhook que você utiliza em Shopify Flow.

2. Escolha como os chamadores comprovam sua identidade

Abra o webhook e escolha um método de autenticação. Consulte Autenticação para ver a comparação completa - a versão resumida:

Token estático - ideal para quase todos. Clique no botão “Gerar”, copie o token, Envie-o no cabeçalho X-Api-Key.
HMAC SHA-256 - para remetentes que assinam suas solicitações (Stripe, GitHub e similares).
Nenhum - apenas para testes. Qualquer pessoa que tenha o URL pode acionar seu fluxo de trabalho.

3. Informe-nos quais áreas são de seu interesse

Na seção “Configurações avançadas”, mapeie até quatro campos do seu payload JSON. Se o seu sistema enviar:

A guia “Configurações avançadas”, com os campos 1 a 4 mapeados para orderId, status, total e note — Configurações avançadas: mapeie até quatro valores do corpo da solicitação. Eles são recebidos em Shopify Flow como fieldOne a fieldFour.

json

{ "customer": { "email": "someone@example.com" }, "orderId": "1001" }

mapeie fieldOne para orderId e fieldTwo para customer.email - os caminhos aninhados utilizam pontos. Detalhes completos em Mapeamento de payload e variáveis de fluxo.

4. Envie uma solicitação de teste

Uma invocação foi aberta no History com seus cabeçalhos de solicitação, payload, status, duração e identificadores — Após uma solicitação de teste, a invocação aparece no Histórico com a payload que foi recebida.

bash

curl -X POST https://your-app-url/webhook/ab12cd34 \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: your-token" \
  -d '{"orderId":"1001","customer":{"email":"someone@example.com"}}'

Abra o Histórico. O senhor deverá visualizar a chamada com seu status, cabeçalhos e payload. Caso ela não conste, a página Histórico e solução de problemas lista todos os motivos de rejeição.

5. Crie o fluxo de trabalho no Shopify Flow

No Shopify Flow, crie um fluxo de trabalho começando com o gatilho “Webhook Trigger”.

Adicione o gatilho e clique em “Registrar eventos”.
Volte até aqui, abra a invocação no Histórico e pressione “Repetir”. O Shopify Flow agora possui um uma payload real para trabalhar - muito mais fácil do que tentar adivinhar os nomes dos campos.
Adicione uma condição: Webhook ID deve ser igual ao ID do seu webhook (exibido na página do webhook). Todo fluxo de trabalho do Webhook Trigger recebe eventos de todos os seus webhooks; portanto, isso Essa condição é o que faz com que o fluxo de trabalho responda apenas a este.
Adicione suas ações, utilizando {{fieldOne}} para {{fieldFour}}.
Ative o fluxo de trabalho.

O ícone de mais, localizado abaixo da etapa “Gatilho do Webhook”, foi aberto, exibindo as opções “Ação” e “Condição” — O símbolo “+” abaixo de uma etapa oferece os dois elementos que compõem um fluxo de trabalho: uma condição e uma ação.

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 painel “Adicionar uma variável” do Shopify Flow para o gatilho Webhook, exibindo webhookId e fieldOne a fieldFour com valores de exemplo de uma solicitação recente — O que o gatilho transmite ao seu fluxo de trabalho: o ID do webhook e seus quatro campos mapeados, exibidos com os valores de uma solicitação recente.

Ação “Enviar e-mail interno” do Shopify Flow, com fieldOne e fieldTwo no assunto e fieldThree e fieldFour na mensagem — Utilize os campos mapeados em qualquer lugar em que uma ação do Shopify Flow receba uma variável, como, por exemplo, no assunto e no corpo de um e-mail interno.

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 “True”.

6. Entrar no ar

Configure seu sistema real para acessar a URL do webhook. Observe as primeiras chamadas no Histórico para confirmar se elas chegam e são bem-sucedidas.

Caso o remetente tente novamente após o tempo limite, ative a opção Proteção contra entregas duplicadas (Não permitir repetição) para que uma nova tentativa não execute seu fluxo de trabalho duas vezes.

A página “Webhooks” apresenta seis webhooks, cada um com sua contagem de invocações, autenticação e um indicador indicando se está “Ativado” ou “Desativado” — A página “Webhooks”. Cada linha mostra a frequência com que o webhook foi chamado, como os chamadores se autenticam e se ele está ativado; o menu à direita permite ativá-lo, desativá-lo ou excluí-lo.