1. Introdução

Um webhook em desenvolvimento Web é um método de ampliar ou alterar o comportamento de uma aplicação, com callbacks personalizados. Na prática, é a forma de enviar e receber informações entre dois sistemas de uma forma passiva. O webhook (também conhecido como retorno de chamada web ou HTTP e, ainda, impulso API) é uma maneira prática para um app ou sistema fornecer outras aplicações com informações em tempo real. No DRAKE o webhook é exclusivo do tipo “send”, ou seja, ele envia informações. As exportações do DRAKE são enviadas ao software terceiro de acordo com as exigências dele, e para isso editamos os dados de saída para que atendam as exigências das portas de entrada do software externo.

Nesse artigo iremos aprender apenas o que fica disponível no DRAKE, mas essa tela é exclusiva para o desenvolvimento da Sapiensia Tecnologia, uma vez que sua ativação e configuração depende do desenvolvimento configurar os dados de saída para a API do terceiro.

2. Permissões de acesso

Apenas “Sapiensia User” podem visualizar essa tela. Não é aberta para usuários comuns.

3. Gerenciar Webhooks

3.1 Acesse a tela de “WebHooks” em: CONFIGURAÇÕES > INTEGRAÇÃO > WEBHOOKS.

Open

3.2 Nessa tela serão listados todos os webhooks cadastrados.

Open

4. Cadastrar/Editar Webhook

4.1 Para cadastrar um novo webhook, clique no botão de “Inclusão“.

Já para editar um webhook existente, basta abrir seu menu de contexto e escolher a opção “Editar“.

4.2 Ao acessar a tela de cadastro/edição, você verá a linha superior:

• Nome: Defina um título para a aplicação.

• Descrição: Campo livre.

• Ponto de extremidade: Aqui serão exibidos os pontos de extremidade do tipo API ativos, cadastrados em “Configurações > Integração > Pontos de Extremidade“.

4.3 Ao clicar em “Adicionar” a janela “Assinatura em evento” será exibida:

• Tipo de evento: Informe o evento a ser enviado via webhook.

• Rota: Informe o caminho final de http.

4.4 Após preencher os dados do webhook, basta clicar em “Salvar“ e o webhook ficará disponível.

5. Remover Webhook

5.1 Para remover um webhook, selecione-o na lista de webhooks e clique na opção “Remover“ no menu de contexto.