Webhooks

Webhooks são uma ferramenta para recuperar e armazenar dados de um determinado evento. Eles permitem que você registre um URL https:// onde os dados do evento podem ser armazenados nos formatos JSON ou XML. Webhooks são normalmente usados para:

• 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 App Store da Shopify 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.

Criar webhooks

Etapas:

Desktop

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

iPhone

1. No app da Shopify, acesse Loja > Configurações.
2. Em Configurações da loja, toque em Notificações.

Android

1. No app da Shopify, acesse Loja > Configurações.
2. Em Configurações da loja, toque em Notificações.

1. Role para baixo até a seção Webhooks.
2. Clique no botão Criar webhook. Uma nova janela deve aparecer.

3. Na primeira lista suspensa, selecione "Evento" na lista a seguir:

   • Criação de carrinho: um webhook será enviado toda vez que um carrinho for criado.
     
   • Atualização do carrinho: um webhook será enviado toda vez que um carrinho for atualizado.
   • Criação de checkout: um webhook será enviado toda vez que um checkout for criado.
   • Exclusão do checkout: um webhook será enviado toda vez que um checkout for excluído.
   • Atualização do checkout: um webhook será enviado toda vez que um checkout for atualizado.
   • Criação de coleções: um webhook será enviado toda vez que uma coleção for criada.
   • Exclusão de coleção: um webhook será enviado toda vez que uma coleção for excluída.
   • Atualização de coleção: um webhook será enviado toda vez que uma coleção for atualizada.
   • Criação de grupo de clientes: um webhook será enviado toda vez que um grupo de clientes for criado.
   • Exclusão do grupo de clientes: um webhook será enviado toda vez que um grupo de clientes for excluído.
   • Atualização do grupo de clientes: um webhook será enviado toda vez que um grupo de clientes for atualizado.
   • Criação de cliente: um webhook será enviado toda vez que um novo cliente for criado.
   • Exclusão de cliente: um webhook será enviado toda vez que um registro do cliente for excluído.
   • Desabilitação de cliente: um webhook será enviado toda vez que uma conta de cliente for desabilitada.
   • Habilitação de cliente: um webhook será enviado toda vez que uma conta de cliente for habilitada.
   • Atualização de cliente: um webhook será enviado toda vez que um registro do cliente for atualizado.
   • Criação de rascunho de pedido: um webhook será enviado toda vez que um rascunho de pedido for criado.
   • Exclusão de rascunho de pedido: um webhook será enviado toda vez que um rascunho de pedido for criado.
   • Atualização do rascunho de pedido: um webhook será enviado toda vez que um rascunho de pedido for atualizado.
   • Criação de processamento: um webhook será enviado toda vez que um processamento for criado em um pedido.
   • Atualização de processamento: um webhook será enviado toda vez que o processamento for atualizado em um pedido.
   • Cancelamento de pedido: um webhook será enviado toda vez que um pedido for cancelado.
   • Criação de pedido: um webhook será enviado toda vez que um pedido for criado.
   • Exclusão de pedido: um webhook será enviado toda vez que um pedido for excluído.
   • Edição de pedido: um webhook será enviado sempre que um pedido for editado.
   • Processamento de pedido: um webhook será enviado toda vez que um pedido for processado.
   • Pagamento do pedido: um webhook será enviado toda vez que um pedido for pago.
   • Atualização do pedido: um webhook será enviado toda vez que um pedido for atualizado.
   • Criação de produto: um webhook será enviado toda vez que um produto for criado.
   • Exclusão do produto: um webhook será enviado toda vez que um produto for excluído.
   • Atualização do produto: um webhook será enviado toda vez que um produto for atualizado.
   • Criação de reembolso: um webhook será enviado toda vez que um reembolso for emitido.
   • Atualização da loja: um webhook será enviado toda vez que uma propriedade da loja for atualizada.
   • Criação de tema: um webhook será enviado toda vez que um tema for criado.
   • Exclusão de tema: um webhook será enviado toda vez que um tema for excluído.
   • Atualização de tema: um webhook será enviado toda vez que uma propriedade do tema for atualizada.

4. Na segunda lista suspensa, escolha o formato em que você gostaria que a Shopify enviasse essas informações para você. As duas opções são JSON ou XML.

5. Em URL, insira o URL no qual os dados devem ser armazenados. É importante observar que os webhooks não podem ser retornados para estes URLs:

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

6. Clique em Adicionar webhook. Seu webhook deve aparecer agora na seção "Webhooks".

7. Você também pode testar seu webhook para garantir que as informações desejadas sejam enviadas para o URL correto. Para fazer isso, clique no link enviar notificação de teste. Verifique no URL que você especificou se isso funciona.

Excluir webhooks

Etapas:

Desktop

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

iPhone

1. No app da Shopify, acesse Loja > Configurações.
2. Em Configurações da loja, toque em Notificações.

Android

1. No app da Shopify, acesse Loja > Configurações.
2. Em Configurações da loja, toque em Notificações.

1. Role para baixo até a seção Webhooks.
2. Ao lado do webhook que você criou, deve haver um ícone de lixeira.
3. Clique no ícone da lixeira para excluir o webhook.

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.