Criar webhooks

Webhooks são uma ferramenta para recuperar e armazenar dados de um determinado evento que permitem registrar um URL https:// onde os dados do evento podem ser armazenados nos formatos JSON ou XML. São comumente usados pelos seguintes motivos:

• Fazer um pedido
• Alterar o preço de um produto
• Notificar seu cliente de mensagens instantâneas ou seu pager quando você estiver offline
• Coletar dados para armazenamento
• Integrar seu programa de contabilidade
• Filtrar os itens do pedido e informar várias transportadoras sobre o pedido
• Remover dados do cliente do seu banco de dados quando eles desinstalarem seu app

Observação

Em caso de falha de um webhook, você recebe uma mensagem no endereço de e-mail do titular da loja. O e-mail é enviado apenas quando o webhook é criado por um app da Shopify App Store ou por um app personalizado. Se o destino do webhook retornar repetidamente uma resposta de status não 200, a assinatura do webhook será excluída automaticamente do admin da Shopify.

Eventos de webhook compatíveis

Ao criar um webhook, é possível selecionar entre um dos eventos listados. Por exemplo, para criar um webhook que seja enviado toda vez que um pedido for pago, selecione Pagamento do pedido. Outro exemplo é: se você quiser criar um webhook enviado toda vez que uma propriedade da loja for atualizada, selecione Atualização da loja.

Tabela de eventos de webhook compatíveis disponíveis no admin da Shopify.

Categoria	Eventos
Carrinho	Criação de carrinho Atualização do carrinho
Checkout	Criação de checkout Exclusão do checkout Atualização do checkout
Coleção	Criação de coleção Exclusão de coleção Atualização de coleção
Cliente	Atualização do consentimento do cliente para marketing por SMS Atualização nas configurações da conta de cliente Criação de cliente Exclusão de cliente Desabilitação de cliente Atualização do consentimento do cliente para e-mail marketing Habilitação de cliente Criação de grupo de clientes Exclusão do grupo de clientes Atualização do grupo de clientes Tags de clientes adicionadas Tags de clientes removidas Atualização de cliente
Desconto	Criação de desconto Exclusão de desconto Atualização de desconto
Rascunho de pedido	Criação de rascunho de pedido Exclusão de rascunho de pedido Atualização de rascunho de pedido
Processamento	Criação de processamento Não é possível concluir o serviço de processamento de pedidos Itens de linha do pedido de processamento preparados para retirada Pedido de processamento movido O pedido de processamento foi colocado em suspensão Pedido de processamento reagendado A ordem de processamento de pedidos que foi agendada vence Encaminhamento do pedido para processamento concluído Processamento de pedido cancelado Solicitação para cancelamento de pedidos de processamento aceita Solicitação de cancelamento do processamento de pedidos rejeitada Solicitação para cancelar o processamento de pedidos enviada Solicitação para processamento de pedidos aceita Solicitação de processamento de pedidos rejeitada Solicitação de processamento de pedidos enviada Processamento de pedidos em espera liberados Itens de linha do processamento de pedidos preparados para entrega local Pedidos de processamento mesclados Divisão de processamento de pedidos Atualização de processamento
Estoque	Criação de item do estoque Exclusão de item do estoque Atualização de item do estoque Conexão de nível do estoque Desconexão de nível do estoque Atualização de nível do estoque
Local	Ativação do local Criação de local Desativação do local Exclusão de local Atualização de local do item
Promover	Criação de mercado Exclusão de mercado Atualização de mercado
Pedido	Cancelamento de pedido Criação de pedidos Exclusão de pedido Edição do pedido Processamento de pedidos Pagamento de pedido Avaliação de risco do pedido alterada Atualização de pedido
Produto	Criação de produto Exclusão de produto Atualização de produto
Reembolsar	Criação de reembolso
Shop	Atualização da loja
Proposta	Criação de transação de caixa
Tema	Criação de tema Exclusão de tema Publicação de tema Atualização de tema
Transação	Criação de transação

Dica

Desenvolvedores podem consultar a lista completa de tópicos de webhook ao criar assinaturas de webhook.

Criar webhooks

É possível criar um webhook quando você quiser. Essas mensagens são assinadas com um ID formado por uma combinação de letras e números exclusivos da loja.

Etapas:

Desktop

1. No admin da Shopify, acesse Configurações > Notificações.

2. Clique em Webhooks.

3. Clique em ⊕ Criar webhook.

4. No menu suspenso Evento, selecione um dos eventos de webhook compatíveis que você quer usar. Vale lembrar que não é possível alterar o evento de webhook após a criação.

5. No menu suspenso Formato, escolha o formato em que você quer que a Shopify envie essas informações para você. As duas opções são JSON ou XML.

6. No campo URL, insira o URL onde você quer que os dados sejam armazenados. Não é possível retornar os webhooks a estes URLs:

   • Localhost
   • Todo URL que termine com a palavra "internal" (como example.com/internal)
   • URLs de domínios personalizados conectados à loja
   • Domínios "falsos" (como www.example.com)
   • Domínios da Shopify (como shopify.com e myshopify.com)

7. Na versão da API Webhook, selecione a versão preferencial do webhook.

8. Clique em Salvar.

iPhone

1. No app da Shopify, toque no botão … e em Configurações.
2. Na seção Configurações da loja, toque em Notificações.
3. Toque em Webhooks.
4. Toque em ⊕ Criar webhook.
5. No menu suspenso Evento, selecione um dos eventos de webhook compatíveis que você quer usar. Vale lembrar que não é possível alterar o evento de webhook após a criação.
6. No menu suspenso Formato, escolha o formato em que você quer que a Shopify envie essas informações para você. As duas opções são JSON ou XML.

7. No campo URL, insira o URL onde você quer que os dados sejam armazenados. Não é possível retornar os webhooks a estes URLs:

   • Localhost
   • Todo URL que termine com a palavra "internal" (como example.com/internal)
   • URLs de domínios personalizados conectados à loja
   • Domínios "falsos" (como www.example.com)
   • Domínios da Shopify (como shopify.com e myshopify.com)

8. Na versão da API Webhook, selecione a versão preferencial do webhook.

9. Toque em Salvar.

Android

1. No app da Shopify, toque no botão ☰ e em Configurações.
2. Na seção Configurações da loja, toque em Notificações.
3. Toque em Webhooks.
4. Toque em ⊕ Criar webhook.
5. No menu suspenso Evento, selecione um dos eventos de webhook compatíveis que você quer usar. Vale lembrar que não é possível alterar o evento de webhook após a criação.
6. No menu suspenso Formato, escolha o formato em que você quer que a Shopify envie essas informações para você. As duas opções são JSON ou XML.

7. No campo URL, insira o URL onde você quer que os dados sejam armazenados. Não é possível retornar os webhooks a estes URLs:

   • Localhost
   • Todo URL que termine com a palavra "internal" (como example.com/internal)
   • URLs de domínios personalizados conectados à loja
   • Domínios "falsos" (como www.example.com)
   • Domínios da Shopify (como shopify.com e myshopify.com)

8. Na versão da API Webhook, selecione a versão preferencial do webhook.

9. Toque em ✓.

Webhooks salvos aparecem na página Webhooks.

Editar webhooks

É possível editar a configuração do webhook após a criação. No entanto, você não tem a opção de modificar o evento de webhook selecionado.

Etapas:

Desktop

1. No admin da Shopify, acesse Configurações > Notificações.

2. Clique em Webhooks.

3. Na linha que contém o webhook que você quer editar, clique em … > Editar.

4. Na caixa de diálogo Editar webhook, modifique o webhook conforme o necessário.

5. Clique em Salvar.

iPhone

1. No app da Shopify, toque no botão … e em Configurações.
2. Na seção Configurações da loja, toque em Notificações.
3. Toque em Webhooks.
4. Na linha que contém o webhook que você quer editar, toque em … > Editar.
5. Na caixa de diálogo Editar webhook, modifique o webhook conforme o necessário.
6. Toque em Salvar.

Android

1. No app da Shopify, toque no botão ☰ e em Configurações.
2. Na seção Configurações da loja, toque em Notificações.
3. Toque em Webhooks.
4. Na linha que contém o webhook que você quer editar, toque em … > Editar.
5. Na caixa de diálogo Editar webhook, modifique o webhook conforme o necessário.
6. Toque em ✓.

Testar webhooks

É possível testar o webhook para verificar se as informações do evento estão sendo enviadas para o URL correto.

Etapas:

Desktop

1. No admin da Shopify, acesse Configurações > Notificações.

2. Clique em Webhooks.

3. Na linha que contém o webhook que você quer testar, clique em … > Teste de envio.

4. No URL que você especificou para o webhook, verifique se a notificação funciona.

iPhone

1. No app da Shopify, toque no botão … e em Configurações.
2. Na seção Configurações da loja, toque em Notificações.
3. Toque em Webhooks.
4. Na linha que contém o webhook que você quer testar, toque em … > Teste de envio.
5. No URL que você especificou para o webhook, verifique se a notificação funciona.

Android

1. No app da Shopify, toque no botão ☰ e em Configurações.
2. Na seção Configurações da loja, toque em Notificações.
3. Toque em Webhooks.
4. Na linha que contém o webhook que você quer testar, toque em … > Teste de envio.
5. No URL que você especificou para o webhook, verifique se a notificação funciona.

Excluir webhooks

É possível excluir um webhook do admin da Shopify. Vale lembrar que essa ação não pode ser desfeita.

Observação

Se o destino do webhook retornar repetidamente uma resposta de status não 200, a assinatura do webhook será excluída automaticamente do admin da Shopify.

Etapas:

Desktop

1. No admin da Shopify, acesse Configurações > Notificações.

2. Clique em Webhooks.

3. Na linha que contém o webhook que você quer excluir, clique em … > Excluir.

iPhone

1. No app da Shopify, toque no botão … e em Configurações.
2. Na seção Configurações da loja, toque em Notificações.
3. Toque em Webhooks.
4. Na linha que contém o webhook que você quer excluir, toque em … > Excluir.

Android

1. No app da Shopify, toque no botão ☰ e em Configurações.
2. Na seção Configurações da loja, toque em Notificações.
3. Toque em Webhooks.
4. Na linha que contém o webhook que você quer excluir, toque em … > Excluir.