TOTVS iPaaS

Atalhos

Árvore de páginas


O Webhook é um dos componentes de início do TOTVS iPaaS que inicializa um diagrama à partir de uma chamada externa. Ao criar um diagrama com um Webhook, algumas configurações são apresentadas neste componente, falaremos mais delas abaixo.



Adicionando o componente no builder

Siga os passos abaixo para adicionar o componente no builder:


01. Com o builder aberto, clique no ícone  e clique no componente Webhook;

02. Clique em Selecionar para incluir o componente do builder;

03. Passe o mouse sobre o componente e clique no ícone .

04. Realize as configurações conforme descrito abaixo nesta documentação.


Configurando o webhook

01. No campo URL vai o caminho na qual a requisição POST deverá ser enviada para acionar o Webhook.

02. No campo Token de segurança vai o API Token que deverá ser enviado no cabeçalho da requisição para acionar o Webhook. O valor no cabeçalho para este campo deve ser apiToken.



Deseja utilizar o serviço com autenticação via URL?

Caso esta opção seja ativada, não é necessário enviar o campo Token no cabeçalho da requisição, pois este estará contido diretamente na URL.


Descartar o conteúdo retornado pelo Webhook?

Ativando essa opção, o TOTVS iPaaS descartará o retorno do payload e o status code retornará 202, conforme demonstrado na imagem abaixo:


Se você optar por não ativar esta opção, o TOTVS iPaaS enviará um payload contendo o messageId, status code 200 e o timestamp, como ilustrado na imagem abaixo:


Como enviar uma requisição?

Saiba como enviar uma requisição através do Webhook seguindo os passos abaixo:

Exemplo sem utilizar a autenticação via URL

As requisições para o Webhook podem ter origens diversas, para exemplo, usaremos os comandos cURL. A seguir mostraremos um exemplo utilizando a API Key no cabeçalho, isso significa que não usaremos o EAI TOTVS neste exemplo.

curl --location --request POST 'https://api-newconnector.staging.totvs.app/connector/api/v1/integrations/9e910673-9b9a-4ad2-a325-35612412cad1/execute' \
--header 'apiKey: 1e3981dd-aa39-4208-b285-61cea7fa0ae7' \
--header 'Content-Type: application/json' \
--data-raw '{
}'

Exemplo utilizando a autenticação via URL

A seguir, uma requisição a partir do exemplo utilizando EAI TOTVS:

curl --location --request POST 'https://api-newconnector.staging.totvs.app/connector/api/v1/integrations/9e910673-9b9a-4ad2-a325-35612412cad1/api-key/1e3981dd-aa39-4208-b285-61cea7fa0ae7' \
--header 'Content-Type: application/json' \
--data-raw '{
}'


Utilizando o corpo da requisição

É possível também, enviar dados para o Webhook e utilizá-los dentro do diagrama. No exemplo abaixo, enviaremos o objeto pessoa:

curl --location --request POST 'https://api-newconnector.staging.totvs.app/connector/api/v1/integrations/9e910673-9b9a-4ad2-a325-35612412cad1/execute' \
--header 'apiKey: 1e3981dd-aa39-4208-b285-61cea7fa0ae7' \
--header 'Content-Type: application/json' \
--data-raw '{
"pessoa":{ "nome": "José Silva", "telefone": "(99) 99999-9999", "email": "[email protected]" }
}'


Enviando desta forma, é possível utilizá-lo a partir do componente Webhook:


Editando o componente

Para diagramas extensos ou que possuem muitas ligações entre componente e aplicativos, existe a possibilidade de editar o componente em casos onde é necessário alterar o componente de início escolhido sem precisar romper as ligações já estabelecidas.


01. Passe o mouse sobre o componente de início Webhook;

02. Clique no ícone  para alterar o componente;

03. A lista com os componentes de início será apresentada, escolha o componente que deseja e clique em Salvar;

04. Uma mensagem de confirmação será apresentada, clique em Prosseguir para salvar as alterações.

Informação

Ao trocar um componente de início, as configurações aplicadas também precisam ser atualizadas, pois cada componente de início tem um tipo de configuração.