Como usar os Webhooks

O que são webhooks?

↑ Back to top

Um Webhook é uma notificação de evento enviada a um URL de sua escolha. Os usuários podem configurá-los para acionar eventos em um site para causar um comportamento em outro.

Os webhooks são úteis para a integração com serviços de terceiros e outras APIs externas que tem suporte para webhooks.

Webhooks no WooCommerce

↑ Back to top

Os webhooks foram introduzidos no WooCommerce 2.2 e podem acionar eventos a cada vez que você adicionar, editar ou excluir pedidos, produtos, cupons ou clientes.

Também é possível usar os webhooks com ações WooCommerce, por exemplo, Criar um webhook para ser usado toda vez que um produto for adicionado ao carrinho de compras, usando a ação woocommerce_add_to_cart.

Os webhooks também facilitam a integração de apps de terceiros com o WooCommerce.

Como criar os webhooks

↑ Back to top

Para criar um novo webhook:

1/ Vá para: WooCommerce > Configurações > Avançado > Webhooks.

2/ Selecione Criar um novo webhook (primeiro webhook) ou Adicionar webhook. A seção Dados do webhook é exibida.

3/ Inserir.

• Nome: O nome é gerado automaticamente como “Webhook criado em [data e hora da criação]” como um padrão para facilitar a criação. Mude o nome para qualquer outro, se desejar.
• Status: Definir como Ativo (entregando), Pausado (não está entregando) ou Desativado (não está entregando por causa de falhas na entrega).
• Tópico: Indicar quando o webhook deve ser acionado – Pedido criado, Produto excluído ou Cliente atualizado. Existem também as opções de Ação e Personalizadas.
  • Evento de ação: Esta opção está disponível quando o Tópico é uma Ação do WooCommerce, como woocommerce_add_to_cart para quando os clientes adicionam produtos ao carrinho de compras.
  • Tópico personalizado: Esta opção é somente para usuários avançados. É possível introduzir novos tópicos personalizados com a ajuda do filtro woocommerce_webhook_topic_hooks.
• URL de entrega: URL na qual o webhook será entregue.
• Segredo: A chave secreta gera um hash do webhook entregue e é fornecida nos cabeçalhos da solicitação. O padrão é a chave secreta do consumidor, do usuário da API atual, se nada for inserido.

4/ Salvar webhook.

Como editar e excluir os webhooks

↑ Back to top

Os webhooks são listados da mesma forma que os posts ou produtos.

1. Encontre o webhook que deseja alterar.
2. Passe o mouse sobre o nome e as opções Editar e Excluir permanentemente são exibidas.
3. Exclua ou Edite e, em seguida, Salve as alterações. Também é possível excluir em massa, usando a lista suspensa.

Logs de webhook

↑ Back to top

O WooCommerce salva os logs de todos os eventos que acionam um webhook. Os logs de webhook são encontrados em: WooCommerce > Status > Logs.

Os logs podem ser revisados ​​a fim de ver a entrega e a resposta do servidor, tornando mais simples a integração e depuração.