Criação de webhooks

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

Realização de um pedido
Alteração do preço de um produto
Notificação do cliente de IM ou pager quando você estiver offline
Coleta de dados para data warehousing
Integração do seu software de contabilidade
Filtragem dos itens do pedido e notificação de várias transportadoras sobre o pedido
Remoção dos dados do cliente do seu banco de dados quando ele desinstala seu app

Nesta página

Eventos de webhook compatíveis

Ao criar um webhook, é possível selecionar qualquer um dos eventos listados. Por exemplo, se quiser criar um webhook que é enviado sempre que um pedido é pago, selecione Pagamento de pedido. Outro exemplo: se quiser criar um webhook que é enviado sempre que uma propriedade da loja é atualizada, selecione Atualização da loja.

Tabela com a lista de eventos de webhook compatíveis disponíveis no admin da Shopify.
Categoria	Eventos
Carrinho	Criação de carrinho Atualização de carrinho
Checkout	Criação de checkout Exclusão de checkout Atualização de 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 das configurações da conta do cliente Criação de cliente Exclusão de cliente Desativação de cliente Atualização do consentimento para e-mail marketing do cliente Ativação de cliente Criação de grupo de clientes Exclusão de grupo de clientes Atualização de grupo de clientes Tags de cliente adicionadas Tags de cliente 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 de pedidos	Criação de processamento de pedido O pedido em processamento não pode ser concluído pelo serviço de processamento de pedidos Itens de linha do pedido em processamento preparados para retirada Pedido em processamento movido Pedido em processamento colocado em suspensão Pedido em processamento reagendado Vencimento do pedido em processamento agendado Conclusão do roteamento de pedidos do pedido em processamento Pedidos de atendimento cancelados Solicitação de cancelamento de pedidos de atendimento aceita Solicitação de cancelamento de pedidos de atendimento recusada Envio da solicitação de cancelamento de pedidos de atendimento Aceitação da solicitação de processamento de pedidos de atendimento Recusa da solicitação de processamento de pedidos de atendimento Envio da solicitação de processamento de pedidos de atendimento Liberação da suspensão de pedidos de atendimento Itens de linha de pedidos de atendimento preparados para entrega local Pedidos de atendimento mesclados Pedidos de atendimento divididos Atualização de processamento de pedido
Estoque	Criação de item de estoque Exclusão de item de estoque Atualização de item de estoque Conexão de nível de estoque Desconexão de nível de estoque Atualização de nível de estoque
Local	Ativação de local Criação de local Desativação de local Exclusão de local Atualização de item do local
Mercado	Criação de mercado Exclusão de mercado Atualização de mercado
Pedido	Cancelamento de pedido Criação de pedido Exclusão de pedido Edição de pedido Processamento de pedido Pagamento de pedido Alteração na avaliação de risco do pedido Atualização de pedido
Produto	Criação de produto Exclusão de produto Atualização de produto
Reembolso	Criação de reembolso
Loja	Atualização da loja
Caixa	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

Criar webhooks

É possível criar um webhook a qualquer momento. Os webhooks são assinados com um ID que consiste em uma combinação de letras e números exclusiva da sua loja.

Etapas:

Desktop

No admin da Shopify, acesse Configurações > Notificações.
Clique em Webhooks.
Clique em ⊕ Criar webhook.
No menu suspenso Evento, selecione um dos eventos de webhook compatíveis que você quer usar como evento de webhook. Não é possível alterar o evento de webhook depois que o webhook é criado.
No menu suspenso Formato, escolha o formato no qual você quer que a Shopify envie essas informações. As duas opções são JSON ou XML.
No campo URL, insira a URL em que você quer que os dados sejam armazenados. Os webhooks não podem ser retornados para as seguintes URLs:
- Localhost
- Qualquer URL que termine com a palavra “internal” (como example.com/internal)
- Qualquer URL de qualquer domínio personalizado anexado à loja
- Domínios “falsos” (como www.example.com)
- Domínios da Shopify (como shopify.com e myshopify.com)
Em Versão da API do webhook, selecione a versão do webhook de sua preferência.
Clique em Salvar.

Mobile

No Shopify app, toque em e, depois, em Configurações.
Na seção Configurações da loja, toque em Notificações.
Toque em Webhooks.
Toque em ⊕ Criar webhook.
No menu suspenso Evento, selecione um dos eventos de webhook compatíveis que você quer usar como evento de webhook. Não é possível alterar o evento de webhook depois que o webhook é criado.
No menu suspenso Formato, escolha o formato no qual você quer que a Shopify envie essas informações. As duas opções são JSON ou XML.
No campo URL, insira a URL em que você quer que os dados sejam armazenados. Os webhooks não podem ser retornados para as seguintes URLs:
- Localhost
- Qualquer URL que termine com a palavra “internal” (como example.com/internal)
- Qualquer URL de qualquer domínio personalizado anexado à loja
- Domínios “falsos” (como www.example.com)
- Domínios da Shopify (como shopify.com e myshopify.com)
Em Versão da API do webhook, selecione a versão do webhook de sua preferência.
Toque em Salvar ou em ✓.

Depois de salvo, o novo webhook é exibido na página Webhooks.

Editar webhooks

É possível editar a configuração de um webhook depois de criá-lo. No entanto, não é possível modificar o evento de webhook selecionado.

Etapas:

Desktop

No admin da Shopify, acesse Configurações > Notificações.
Clique em Webhooks.
Na linha que contém o webhook que você quer editar, clique em ... > Editar.
Na caixa de diálogo Editar webhook, modifique o webhook conforme necessário.
Clique em Salvar.

Mobile

No Shopify app, toque em e, depois, em Configurações.
Na seção Configurações da loja, toque em Notificações.
Toque em Webhooks.
Na linha que contém o webhook que você quer editar, toque em ... > Editar.
Na caixa de diálogo Editar webhook, modifique o webhook conforme necessário.
Toque em Salvar ou em ✓.

Testar webhooks

É possível testar o webhook para confirmar que as informações do evento que você quer estão sendo enviadas para a URL correta.

Etapas:

Desktop

No admin da Shopify, acesse Configurações > Notificações.
Clique em Webhooks.
Na linha que contém o webhook que você quer testar, clique em ... > Enviar teste.
Na URL especificada para o webhook, verifique se a notificação funciona.

Mobile

No Shopify app, toque em e, depois, em Configurações.
Na seção Configurações da loja, toque em Notificações.
Toque em Webhooks.
Na linha que contém o webhook que você quer testar, toque em ... > Enviar teste.
Na URL especificada para o webhook, verifique se a notificação funciona.

Excluir webhooks

É possível excluir um webhook no admin da Shopify. Essa ação não pode ser desfeita.

Etapas:

Desktop

No admin da Shopify, acesse Configurações > Notificações.
Clique em Webhooks.
Na linha que contém o webhook que você quer excluir, clique em ... > Excluir.

Mobile

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