Webhooks notificam serviços externos, como clientes de chat ou outras APIs externas, sobre eventos. Um webhook pode definir uma URL quando um evento específico ocorre.
O Orquestrador de Frases fornece um serviço que monitora e processa notificações de sistemas de terceiros. Este serviço permite que os usuários conectem seus fluxos de trabalho a uma ampla variedade de sistemas externos que suportam requisições HTTP.
Os usuários podem criar um novo acionamento para webhooks de entrada a partir de eventos externos, com o sistema gerando automaticamente uma URL de webhook única com chave de API para a configuração do webhook de terceiros. A URL de webhook gerada é única e está diretamente associada à conta e ao fluxo de trabalho do usuário, o que significa que cada webhook está vinculado a apenas um fluxo de trabalho.
Configurar webhook de entrada
Para configurar um webhook de entrada, siga estas etapas:
-
Arraste e solte um acionamento em um fluxo de trabalho.
O acionamento aparece no fluxo de trabalho.
-
Clique no acionamento para abrir a aba .
-
Selecione a aba .
-
Copie o .
Esta URL deve ser considerada um segredo e não compartilhada. Se for compartilhada por acaso, clique em Regenerate para criar uma nova e invalidar a existente.
-
Para enviar um payload com dados a serem usados dentro dos fluxos de trabalho, forneça o esquema desse payload.
-
Para fornecer um esquema, clique em Edit webhook.
-
Selecione um :
JSON Schemas são um padrão para definir cargas úteis JSON. Se um serviço existente que os utiliza, ou um serviço externo para conectar ao Orchestrator fornecer um, copie-o como está.
-
JSON
Forneça uma carga útil JSON de exemplo para uma configuração mais simples, permitindo testar o webhook sem definir regras exatas.
-
JSON Schema
Defina precisamente a estrutura, os tipos de dados e as regras de validação para os dados JSON.
-
-
Clique Save payload schema.
Uma prévia da estrutura de dados esperada para o acionamento do webhook é exibida.
-
-
Se necessário, abra a aba para adicionar filtros ao acionamento.
-
Para acionar um fluxo de trabalho uma vez que tenha sido publicado, envie uma solicitação POST para a URL do webhook. Para fluxos de trabalho que não têm um esquema configurado, o corpo deve estar vazio. Se um esquema configurado for aplicado, a carga útil deve corresponder ao esquema.
Os usuários podem configurar fluxos de trabalho que não apenas recebem dados, mas também enviam atualizações para sistemas externos automaticamente. A ação de webhook de saída permite que os usuários acionem automaticamente ações específicas em sistemas externos.
Webhooks em outros serviços podem ser acionados através da ação Enviar Solicitação HTTP.
Configurar um webhook de saída
Para configurar um webhook de saída, siga estas etapas: