Cadastro de Webhooks (FUTL0244)

FoccoERP Webhooks

O Focco Webhooks tem como objetivo o cadastro, configuração e disparo de ações referentes a qualquer alteração cadastral feita no FoccoERP, com a finalidade de manter usuários e parceiros atualizados sobre qualquer atualização de tabelas do sistema.

• Cadastrando um Webhook

  • Primeiramente é necessário definir a ação do Webhook, isto é, se ele se refere a uma inclusão, alteração ou exclusão. Somente será possível informar filtros/campos quando o tipo do Webhook for "Alteração".

  • É obrigatório também que seja informada a tabela de banco de dados referente ao processo que deseja se notificar os parceiros, bem como os respectivos campos.

  • Os filtros informados têm por objetivo definir os campos que serão monitorados para envio de notificação para o parceiro.

  • Por fim, informa-se a URL que será utilizada para execução do Webhook. É possível também testar a comunicação do Webhook configurado com a URL cadastrada antes de salvar o cadastro.

Sobre a Execução de Webhooks

• Só serão disparadas ações enquanto o Webhook estiver com status Ativo. É possível inativar bem como reativar um Webhook.

  • O processo de envio do conteúdo para a URL configurada contempla o conceito de resiliência, isto é, ao realizar 5 tentativas sem sucesso será considerada como falha de envio. Em caso de 25 falhas recorrentes ocorrerá a inativação automática do Webhook. Além disso, a inativação automática acontece também quando ocorre o sincronismo de bases.

  • Em caso de desativação automática dos Webhooks por excesso de falhas, os usuários pertencentes ao grupo de administradores serão notificados via FoccoERP.

• Sobre a ordem de execução dos Webhooks: a execução do envio é realizada de forma sequencial, dos registros mais antigos para os mais novos.

• Resultado da execução de um Webhook: a execução de um Webhook poderá ter dois status: Falha ou Sucesso. Será gerado um JSON contendo todos os dados referentes a tabela envolvida.

• No histórico de execução de Webhooks será exibido e armazenado os registros dos últimos 7 dias.

Importante

A capacidade de processamento de webhooks diária é estimada em 250 mil registros, porém esta capacidade poderá variar de acordo com a infraestrutura local e/ou complexidade dos webhooks cadastrados.

Importante

Campos do tipo BLOB não serão considerados e não estarão no JSON gerado.

Exemplo de JSON enviado da tabela TCLIENTES:

Exemplo de cadastro:

Atenção

Existem casos específicos onde os disparos de Webhooks não ocorrerão, caso as alterações dos campos de filtro informados sejam originados a partir de processos internos automáticos da aplicação. Essas situações, embora não sejam facilmente mapeáveis, normalmente ocorrem em programas que têm um grau de complexidade maior. Normalmente estes casos podem ser solucionados utilizando um Webhook sem campos de filtros ou substituindo o campo de filtro.

Situações já mapeadas: