Global Construção - Configurações - Webhooks

Importante

Funcionalidade disponível a partir as versões 5.00.00.30 e 5.02.01.99.

Criação de webhooks para obter atualizações em tempo real

Introdução

Esta integração visa tornar o Carteira de Recebíveis plugável com qualquer sistema externo através de webhooks. Os sistemas externos interessados em receber atualizações de dados do Carteira poderão receber eventos através do cadastro de webhooks nos eventos pré-determinados.

Eventos

Os eventos são nossa maneira de informar quando algo interessante acontece no Carteira. Quando ocorre um evento, o sistema verifica se existe um webhook cadastrado para recebê-lo e na sequência é enviada uma requisição Post para seu endpoint.

Cada evento retorna um objeto diferente.

Grid Gestão de Webhooks

Esta grid é controlada pelos botões de + Inserir, Editar e Excluir da tela.

Logs de Integração por evento

Esta grid exibe os logs das requisições.

Filtros da grid

As informações desta grid podem ser filtradas por:

Data Inicial e Data Final.
Eventos ou status.

Criar Webhooks

Criar webhook é um processo simples, basta acessar Global Construção > Configurações > Webhooks e em seguida, clicar no botão + Inserir.

Defina o Nome do webhook e a Url ou endpoint para onde serão realizadas as requisições.
Gere o segredo.

Observação

Todos os campos são de preenchimento obrigatório.

HMAC Secret:

O campo Secret contém uma sequência de 16 caracteres, composta por letras, números e símbolos.
Ao lado do campo Secret, há um botão que permite gerar automaticamente o conteúdo dessa sequência.
O sistema externo utiliza o conteúdo do campo Secret para descriptografar informações e validar requisições.
O método de segurança utilizado é o HMAC (Hash-based Message Authentication Code).

Após adicionar um novo webhook, será exibido no grid superior da tela principal, a lista de webhooks cadastrados e no grid inferior os logs de todas as requisições enviadas para determinado webhook.

Especificação da requisição

Objeto

Método: Post
Body: raw/json

Exemplo

[{
"cto_in_codigo":"190", //código do contrato recém gerado
"cnd_in_codigo":"12001", //código da proposta do mega
"cnd_in_propostaexterna":"3392" //código da proposta do sistema externo de pré-venda
},
{
"cto_in_codigo":"191", //código do contrato recém gerado
"cnd_in_codigo":"12002", //código da proposta do mega
"cnd_in_propostaexterna":"3393" //código da proposta do sistema externo de pré-venda
}]

"x_tenant": "888a0263-6526-4152-851d-e916k3504b70" //identificador do cliente na mega, quando cloud 
"cliente": "60630221000175" //identificador do cliente (cnpj sem caracteres especiais)
"hmac_secret": " /* Método + Body + Url criptografados com este método*/"

PORTAL DE DOCUMENTAÇÃO
ERP Mega - Manual do Usuário