Gatilhos Webhook: Adição e Configuração
Last updated
Last updated
A seguir, saiba adicionar e configurar um Gatilho Webhook:
Para adicionar um gatilho Webhook, siga os seguintes passos:
Clique em "Comece com um gatilho".
Clique no sinal de mais da opção Webhook. Em seguida, abrirá o modal para configurá-lo e visualizar mais informações.
Este modal é dividido nas seguintes áreas: Cabeçalho, Configurações e Especificações da Requisição.
Por padrão, o endereço do Webhook é predefinido na plataforma, sendo possível copiá-lo no ícone específico - localizado no lado direito da tela.
Além disso, há a opção de "Solicitar autenticação". Sem utilizar OpenAPI, você terá somente a opção de ativar a solicitar autenticação com Usuário (predefinido) e Senha (obrigatória), que não serão exigidos ao rodar o fluxo dentro da plataforma:
Especificações da requisição
Os fluxos do Skyone Data podem ser acionados utilizando os seguintes formatos de MEDIA TYPE (tipo de mídia):
application/json
application/x-www-form-urlencoded)
Selecione um dos dois, conforme a sua necessidade, utilizando a seta no canto direito.
Limite de execuções
É possível gerenciar a quantidade de execuções do seu Gatilho Webhook através do "Limite de Execuções", ou seja, determinar o máximo de vezes em que o WebHook será requisitado durante um período de tempo.
Para isso, escolha o número e a medida de tempo (segundo, minuto ou hora) desejados.
Em "Utilizar Body na requisição", use o botão de ativar para mostrar o recurso. Por padrão, a aba Body é apresentada:
Caso queira utilizar o formato JSON para que a plataforma converta o código em YAML, utilize esta aba da configuração do gatilho Webhook e clique em "Gerar Schema".
A plataforma verificará se o seu JSON é válido e, se estiver tudo certo, gerará o seu schema em YAML automaticamente.
Opcionalmente, você pode utilizar apenas o BODY, sem gerar um schema em YAML, clicando em "Salvar" para guardar as alterações. Isso fará com que o Skyone Data não faça a validação do tipo de parâmetro utilizado.
Caso exista algum erro, verifique a mensagem de erro, faça as correções necessárias e tente novamente.
Além de adicionar um gatilho Webhook simples, podemos adicionar utilizando um OpenAPI - configurações opcionais, mas que permitem que passemos parâmetros diretamente no gatilho, já no começo da requisição POST.
Para começar, em "Utilizar Body na requisição", use o botão de ativar para acionar o recurso. Em seguida, escolha a aba "Open API Schemas".
Aqui, você terá a opção de especificar o seu schema, adicionando parâmetros, caso queira escrever o seu schema diretamente em YAML. Quaisquer parâmetros adicionados devem estar contidos na variável webhook_request. No exemplo acima, temos um schema simples, com o parâmetro csv, que deve ser do tipo string. Este parâmetro deve ser informado no momento da requisição pelo POSTMAN (ou similar). Para melhor visualização, segue o mesmo código em texto:
Para finalizar as configurações do gatilho, clique em "Salvar".
.
Este campo permite que você utilize um body no formato JSON, que você pode ou não querer converter para YAML. Quando usado, aparece como um parâmetro com o mesmo nome (body) nos demais componentes do fluxo, sendo possível filtrar seus dados por meio de uma ou do módulo ferramental
Leia também:
