TOTVS iPaaS

Atalhos

Árvore de páginas



O Webhook Síncrono é um dos componentes de início do TOTVS iPaaS. A ativação desse fluxo é feita a partir de uma chamada externa. Diferentemente do componente chamado Webhook convencional, o Webhook Síncrono tem a função de fornecer respostas em poucos segundos, tornando-o ideal para casos em que uma resposta imediata é necessária. Este componente é composto por dois elementos-chave: o próprio Webhook Síncrono e o Componente de Resposta. Ao criar um diagrama com um Webhook Síncrono, algumas configurações são apresentadas neste componente, falaremos mais delas abaixo.



Adicionando o componente do builder

Siga os passos abaixo para adicionar o componente no builder:


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

Ao selecionar o componente de início Webhook síncrono no diagrama, não poderão ser utilizados os componentes Splitter, Global Error e Throw Exception no diagrama. Mais detalhes podem ser encontrados no tópico Restrições. 

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

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

04. Realize a configuração conforme demonstrado nesta documentação.


Configurando o Webhook Síncrono


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

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.


Configurando o componente de resposta Webhook Síncrono


É possível configurar a resposta desejada, criando um objeto ou arrastando as tags dos resultados anteriores. Além disso, é possível configurar o código de status HTTP a ser retornado. Por padrão, o campo HTTP Status retorna o código 200. Se desejar um código de status diferente, é possível modificar o código nesse campo. 

Na imagem abaixo, podemos observar a configuração do componente de resposta síncrona, onde inserimos o resultado da consulta anterior no corpo do componente.



Resultado


Veja abaixo o formato da resposta:


As tags "messageId" e "timestamp" são tags padrões do TOTVS iPaaS. Já a tag "status" foi configurada no campo "http status" dentro do componente de resposta, enquanto a tag "result" contém o resultado da chamada, a qual foi inserida no corpo do componente de resposta


Restrições

  • Não é permitido a utilização dos seguintes componentes em integrações síncronas:
    • Splitter
    • Global Error
    • Throw Exception
  • O contrário também acontece. Ao adicionarmos um dos componentes acima, não é permitido a utilização do trigger webhook síncrono;
  • A resposta síncrona só pode ser utilizada em integrações que utilizam o webhook síncrono;
  • A resposta síncrona tem como valor padrão no campo HTTP Status o código 200;
  • Paralelismo não é permitido em integrações síncronas, porém é possível fazer fluxos de if e else;
  • Integrações síncronas não permitem reprocessamento.


Como enviar uma requisição?


Disponibilizamos exemplos de como enviar uma requisição através do webhook síncrono seguindo os passos abaixo:

Exemplo sem utilizar a autenticação via URL

As requisições para o Webhook Síncrono 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 a autenticação na URL neste exemplo.

curl --location 'https://api-ipaas.totvs.app/sync-hook/api/v1/integrations/id-do-webhook-sincrono/execute' \

--header 'apiKey: api-key-do-componente' \

--header 'Content-Type: application/json' \

--data '{

}'

Exemplo utilizando a autenticação via URL

A seguir, uma requisição a partir do exemplo de autenticação na URL

curl --location 'https://api-ipaas.totvs.app/sync-hook/api/v1/integrations/id-do-webhook-sincrono/api-key/api-key-do-componente' \

--header 'Content-Type: application/json' \

--data '{

}'


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 síncrono;

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.