TOTVS iPaaS

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 2

changes.mady.by.user Samara Buettgen

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Hugo Henrique Mesquita Severo da Silva

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

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.


Image Added


Adicionando o componente no builder

...

Siga os passos abaixo para adicionar o componente no builder:


01. Com o builder aberto, clique no ícone Image Added 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 Image Added.

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


Configurando 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 apiKey.


Image RemovedImage Added


Painel
borderColor#f2f2f2
bgColor#f2f2f2

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.

...


Image Added

Painel
borderColor#f2f2f2
bgColor#f2f2f2

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:


Image Added

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:


Image Added

Como enviar uma requisição?

...

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

...

Painel
borderColor#f2f2f2
bgColor#f2f2f2

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

...

Painel
borderColor#f2f2f2
bgColor#f2f2f2

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

...

Painel
borderColor#f2f2f2
bgColor#f2f2f2

curl --location --request POST 'https://api-newconnectoripaas.staging.totvs.app/connectoripaas/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:Image Removed

Image Added


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 Image Added 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ções
titleInformaçã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.