Webhooks é uma forma de recebimento de informações quando um evento acontece. A tela de cadastro de webhook (Módulo Administração, Menu Administrar, Submenu Webhook) é dividida em duas partes. Primeiramente, existe a tela de filtro, na qual o usuário poderá buscar por webhooks já cadastrados e realizar ações em cima destes. Além disso, é possível cadastrar um novo webhook, sem necessidade de realizar qualquer busca nos filtros, através do botão Novo Webhook.
Ao clicar no botão Novo Webhook, o usuário será direcionado a tela de detalhe na qual será possível preencher os seguintes campos:
- Nome: nome da configuração de webhook.
- Situação: situação da configuração de webhook. Opções disponíveis: Ativo e Inativo.
- Tipo Requisição: tipo de conteúdo da requisição. Opção disponível: application/json.
- Desabilitar verificação SSL: por padrão, o sistema verificará o certificado SSL quando a URL for https. Quando apresentar problemas com o certificado SSL, o usuário pode desabilitar a verificação SSL.
- URL: URL na qual será feito o disparo da notificação.
- Chave Secreta: senha da URL.
- Eventos: eventos geradores de notificações para este webhook.
Eventos de Acordo disponíveis para seleção:
* Acordo
- Acordo - Inclusão: disparar notificação ao incluir um acordo.
- Acordo - Alteração: disparar notificação ao alterar (modificar situação, receber pagamentos, etc) um acordo.
- Acordo - Cancelamento: disparar notificação ao cancelar/não cumprir um acordo.
* Pagamento
- Pagamento - Inclusão: disparar notificação ao receber um pagamento.
- Pagamento - Cancelamento: disparar notificação ao estornar um pagamento.
Eventos de Clientes disponíveis para seleção:
* Dívida
- Dívida - Aberto: disparar notificação ao cliente estar com dívidas em aberto.
- Dívida - Fechado: disparar notificação ao cliente estar com dívidas fechadas.
* Endereço
- Endereço - Inclusão: disparar notificação ao incluir um endereço.
- Endereço - Alteração: disparar notificação ao alterar um endereço.
- Endereço - Exclusão: disparar notificação ao excluir um endereço.
- E-mail - Inclusão: disparar notificação ao incluir um endereço de e-mail.
- E-mail - Alteração: disparar notificação ao alterar um endereço de e-mail.
- E-mail - Exclusão: disparar notificação ao excluir um endereço de e-mail.
* Telefone
- Telefone - Inclusão: disparar notificação ao incluir um telefone.
- Telefone - Alteração: disparar notificação ao alterar um telefone.
- Telefone - Exclusão: disparar notificação ao excluir um telefone.
Após preencher os campos e clicar em Salvar, o usuário é direcionado novamente a tela de filtro com a mensagem de sucesso. Se o usuário clicar em Cancelar, ele será direcionado a tela de filtro sem realizar a inclusão do novo webhook.
Na tela de filtro, existe a possibilidade de editar os webhooks já cadastrados. Ao clicar no botão Editar Webhook (ao lado de cada registro na tela de filtro), o usuário será direcionado a tela de detalhe na qual será possível alterar todos os campos apresentados.
0 Comentários