Esse recurso está disponível apenas para clientes Enterprise. Entre em contato com seu CSM se desejar ativá-lo.
Este artigo explica:
Eventos que acionam alertas em tempo real
Com o webhook de alerta em tempo real, você pode ser notificado em tempo real quando eventos de seu interesse forem iniciados. Esses eventos podem ocorrer em qualquer lugar em nosso sistema, mas, no momento, estão limitados aos cinco eventos listados abaixo:
-
Uma transferência falhou.
-
Uma ação falhou.
-
Uma mensagem de erro técnico genérico foi enviada no chat.
-
Uma integração de back-end personalizada falhou. Nesse caso, a integração de back-end exata é especificada no objeto
data. - Teste – um evento de teste pode ser acionado no painel do Agentes de IA - Avançado para que os desenvolvedores possam testar e implementar o uso do webhook sem precisar esperar por um dos gatilhos.
Assim que um dos eventos for acionado, enviaremos uma solicitação com o seguinte parâmetro para a URL do webhook:
| Nome | Type | Descrição |
| botName | cadeia de caracteres | Nomear o agente de IA que acionou o evento |
| evento | cadeia de caracteres | Os cinco tipos diferentes de eventos |
| conversationId | cadeia de caracteres | ID exclusivo da conversa |
| platformConversationId | cadeia de caracteres | ID da conversa específica da plataforma |
| data | objeto | Metadados, mais usados por eventos de integração de back-end |
Para o evento personalizado de integração de back-end, enriqueceremos o objeto de dados com o seguinte parâmetro:
| Nome | Type | Descrição |
| botId | cadeia de caracteres | Uma combinação de letras e números de 24 dígitos que é exclusiva para cada agente de IA. Saiba mais. |
| conversationId | cadeia de caracteres | ID exclusivo da conversa |
| conversationLink | cadeia de caracteres | Link para a conversa especificada nos registros de conversas |
| httpStatus | número | Tipo de status do erro |
| endpointUrl | cadeia de caracteres | URL alvo da integração de back-end |
Configuração do webhook
A configuração do webhook pode ser acessada nas configurações do agente de IA > Geral > Webhook. Isso é visível apenas para clientes corporativos.
Para configurá-lo, siga as instruções abaixo:
- Em Agentes de IA - Avançado, acesse Configurações de agente de IA > Geral > Webhook
-
Copie e cole a URL do webhook de sua ferramenta de dados no campo definido. Lembre-se de que permitimos apenas URLs https.
-
Clique em Mostrar token e use o token de autenticação para recuperar com êxito as mensagens de alerta em sua ferramenta de dados.
-
Clique em Usar webhook para acompanhar o desempenho do agente de IA para ativar a funcionalidade.
- Salve as configurações atualizadas do agente de IA. O botão de teste do webhook deve estar ativado agora.
-
Clique em Testar webhook para enviar um evento de teste para a URL especificada como a URL do webhook. A última etapa é opcional, mas recomendada.