Developer Center
Pesquisar K

Appearance

Como criar um webhook ​

Um webhook permite que você seja notificado quando um evento específico acontece em algum item dentro da sua comunidade do E-commerce. Caso você não saiba o que é um webhook e como ele funciona, veja aqui

Onde configurar os webhooks ​

Ao acessar a aba de E-commerce da Layers, você verá a seguinte tela na lateral esquerda:

home

Clique na aba "Configurações". Você verá a seguinte tela:

tela_configuracoes_pagamentos

Na lateral esquerda, clique na aba "Webhooks". É nela que você poderá criar e editar seus webhooks. Pronto! Agora você sabe como acessar a configuração de webhooks.

Conhecendo a tela de webhooks ​

Na aba de webhooks, você verá a seguinte interface com duas abas: "Configurações" e "Histórico".

Aba Configurações ​

tela_webhooks1

Na aba "Configurações", é possível visualizar todos os webhooks existentes na sua comunidade em formato de tabela, com informações como nome, URL, quantidade de eventos, status (Operacional ou Inativo) e ações disponíveis. Você pode criar novos webhooks clicando no botão "+ Novo webhook".

Aba Histórico ​

tela_webhooks2

Na aba "Histórico", é possível visualizar todos os envios de webhooks, com informações como data, evento, Entity ID, URL, status, código HTTP e ações. A aba também conta com filtros para facilitar a busca por envios específicos.

Como criar um webhook ​

Para criar um webhook, clique no botão "+ Novo webhook" no canto superior direito. Um painel lateral será aberto:

aba_criar_webhook

Abaixo, está a explicação de cada campo:

  • Nome do webhook: nome para facilitar a identificação do webhook. Caso não seja passado, será utilizado o hostname da url
  • URL de envio das webhooks: endereço para onde os webhooks serão enviados;
  • Chave de autenticidade: chave secreta para autenticar seu webhook;

Para entender melhor acerca dos eventos possíveis em um webhook, veja as referências sobre os eventos possíveis em webhooks

Você pode escolher quantos eventos quiser para ativar seu webhook.

Após preencher todas as informações, clique no botão "Criar". Pronto! Agora você tem um webhook configurado.

Visualizando detalhes de um envio ​

Na aba "Histórico", ao clicar no botão de detalhes (ícone de olho) na coluna "Ações" de um envio atividade_webhook

Após isso, abrirá um painel lateral com os detalhes do webhook: tela_reenvio_webhooks_detalhes_2

Nessa tela, você pode ver informações detalhadas sobre o envio do webhook, incluindo status, evento, tentativas realizadas, e as abas "Informações", "Request" e "Response" com o conteúdo da requisição e da resposta.