Webhooks do Closedloop

Webhooks do Closedloop permitem que Administradores do Workspace configurem webhooks de saída que acionam APIs externas com base em eventos e condições relacionadas a Tickets do Closedloop. Você pode selecionar um evento de Ticket, adicionar condições opcionais, configurar a solicitação da API, testar a configuração e ativar o webhook.

Você também pode incluir Objetos e Campos de Ticket suportados no corpo da solicitação JSON e revisar os resultados das execuções do webhook através dos logs de execução.

Assista a este vídeo para aprender a usar webhooks no Closedloop

Apenas Administradores do Workspace podem criar, editar, habilitar, desabilitar e excluir Webhooks. Usuários que não são Administradores do Workspace não podem gerenciar configurações de webhook.

Navegue até Experiência do Cliente → Closedloop → Configurações do Workspace → Webhooks.

1. Navegue até Experiência do Cliente → Closedloop → Configurações do Workspace → Webhooks.
2. Clique em + Adicionar Novo Webhook.

3. Insira uma descrição do webhook. A descrição pode conter até 60 caracteres.
4. Configure o evento acionador e quaisquer condições necessárias na etapa Lógica de Acionamento.
5. Clique em Próximo.

6. Configure a solicitação da API na etapa Solicitação da API.
7. Use Executar Teste para testar a configuração da API antes de salvar o webhook.
8. Revise o resultado do teste e faça quaisquer alterações necessárias.

9. Configure o mapeamento de dados para a resposta da API e salve o webhook. Webhooks recém-criados são habilitados automaticamente.

Você pode configurar um webhook para acionar quando qualquer um dos seguintes eventos de Ticket do Closedloop ocorrer:

• Ticket criado
• Ticket excluído
• Ticket atribuído
• Status do Ticket alterado
• Prioridade do Ticket alterada
• Comentário do Ticket adicionado
• Status de inatividade do Ticket
• Violação de SLA de Ação
• Violação de SLA de Resolução

Você pode adicionar condições com base em Segmento Atual, Pesquisa e Variável Personalizada.

1. Na etapa Lógica de Acionamento, selecione um tipo de condição.
2. Selecione o valor exigido nas opções disponíveis no menu suspenso.
3. Para Variável Personalizada, selecione o nome da variável e seu valor.

O operador de condição suportado é É. Quando várias condições estão configuradas, todas as condições devem corresponder para o webhook ser executado.

Se nenhuma condição for configurada, o webhook é elegível para executar sempre que seu evento acionador configurado ocorrer.

Um webhook habilitado é executado quando seu evento de Ticket configurado ocorre e todas as condições configuradas correspondem.

Se uma condição configurada não corresponder, o webhook não é executado. Webhooks desabilitados não executam quando seu evento configurado ocorre.

1. Na etapa Solicitação da API, insira a URL da API. A URL da API é obrigatória.
2. GET, POST e PUT métodos da API são suportados atualmente.
3. Selecione o método de autenticação requerido.
4. Configure os cabeçalhos da solicitação conforme necessário.
5. Para solicitações POST e PUT, configure o corpo da solicitação usando JSON válido, se necessário.
6. Revise a configuração e use Executar Teste para validar a solicitação.

Para solicitações GET, o corpo da solicitação é desabilitado.

Webhooks do Closedloop suportam os seguintes métodos de autenticação:

• Sem Auth: Nenhum detalhe de autenticação é necessário.
• Chave da API: Insira a Chave e o Valor, e selecione se a chave da API deve ser adicionada ao cabeçalho da solicitação ou parâmetro da consulta.
• Token Bearer: Insira o Token.
• Auth Básica: Insira o Nome de Usuário e a Senha.

Sim. Você pode configurar cabeçalhos de solicitação como pares chave/valor ao configurar a solicitação da API.

Corpos de solicitação estão disponíveis para solicitações POST e PUT. O corpo da solicitação é opcional e deve conter JSON válido.

Você pode inserir Objetos e Campos de Ticket suportados no corpo da solicitação a partir da interface de configuração.

Você pode inserir os seguintes Objetos de Ticket suportados:

• {{ticket.details}}
• {{ticket.conversationHistory}}
• {{ticket.commentsHistory}}
• {{ticket.activityHistory}}
• {{ticket.rootCauseActions}}
• {{ticket.responseDetails}}

Você pode inserir os seguintes Campos de Ticket suportados:

• {{ticket.id}}
• {{ticket.status}}
• {{ticket.priority}}
• {{ticket.createdDate}}
• {{ticket.assignee}}
• {{ticket.currentSegment}}
• {{ticket.firstActionSla}}
• {{ticket.resolutionSla}}
• {{ticket.description}}

1. Complete a configuração da solicitação da API.
2. Clique em Executar Teste.
3. O Closedloop executa a solicitação da API configurada usando a autorização configurada, cabeçalhos da solicitação e corpo da solicitação.
4. Revise o resultado do teste exibido no modal pop-up.
5. Revise a URL da API e a resposta ou resultado retornados.

Se a execução do teste falhar, o pop-up exibe uma mensagem ou razão apropriada para a falha.

A resposta completa da API é armazenada no sistema Resposta do webhook. A resposta não é armazenada diretamente no Ticket do Closedloop.

1. Navegue até Experiência do Cliente → Closedloop → Configurações do Workspace → Webhooks.
2. Clique no Nome do Webhook para o webhook que você deseja revisar.
3. Clique em Logs ao lado de Configuração.

Cada execução de webhook é registrada nos logs de execução.

Os logs de execução incluem:

• ID do Webhook
• Timestamp
• ID do Ticket
• Resposta
• Status HTTP

Respostas de API falhadas também são registradas nos logs de execução.

Clique no ID de execução nos logs de execução do webhook para abrir as informações detalhadas da execução em um modal.

O modal de detalhes inclui a URL de solicitação, Payload e resposta da API.

1. Navegue até Experiência do Cliente → Closedloop → Configurações do Workspace → Webhooks.
2. Localize o webhook que você deseja modificar.
3. Use o Editar controle para o webhook.
4. Atualize a configuração necessária.
5. Salve as alterações.

Administradores do Workspace podem editar webhooks existentes.

Administradores do Workspace podem habilitar ou desabilitar webhooks existentes a partir da página de configuração de Webhooks.

Quando um webhook é desabilitado, ele não é executado quando seu evento de Ticket configurado ocorre.

1. Navegue até Experiência do Cliente → Closedloop → Configurações do Workspace → Webhooks.
2. Localize o webhook que você deseja remover.
3. Clique no Excluir controle para o webhook.
4. Confirme a exclusão.

Solicitações da API falhadas são registradas nos logs de execução do webhook. Solicitações da API falhadas não são automaticamente reexaminadas e não acionam uma ação adicional do Ticket Closedloop.

• Configure integrações entre Closedloop e sistemas externos sem configuração de integração separada para cada fluxo de trabalho.
• Controle quais eventos de Ticket acionam APIs externas.
• Use condições para garantir que apenas eventos de Ticket relevantes invoquem uma API externa.
• Configure autenticação e cabeçalhos da solicitação para solicitações de API externas.
• Construa corpos de solicitação JSON usando Objetos e Campos de Ticket suportados.
• Teste configurações de API antes de ativar um webhook.
• Revise os resultados da execução do webhook através de logs de execução padronizados.

• Use uma descrição clara do webhook para que o propósito da configuração seja fácil de identificar.
• Configure condições quando a API externa deve ser acionada apenas para critérios específicos de Ticket.
• Revise a URL da API, autenticação, cabeçalhos e corpo da solicitação antes de salvar o webhook.
• Use Executar Teste para validar a configuração da API antes de confiar em eventos de Ticket ao vivo.
• Revise logs de execução para monitorar solicitações de webhook e respostas de API.