Saltar para o conteúdo
AurionAI

Webhooks de notificação

4 min de leituraPor Emmanuel Yazbeck

Um webhook de notificação envia eventos de notificação do AurionAI para outro sistema, por exemplo uma ferramenta de chat. O AurionAI publica cada evento como um corpo JSON no endereço que introduzir.

Disponibilidade: Perfis Helpdesk e AI Voice + Helpdesk. Apenas administradores.

Pré-requisitos

  • Tem a função Proprietário ou Administrador. Os outros utilizadores veem Acesso Negado.
  • A sua organização utiliza o perfil Helpdesk ou o perfil AI Voice + Helpdesk.
  • Um endereço HTTPS público que aceite pedidos POST com um corpo JSON.

Abrir os webhooks de notificação

  1. Na barra lateral, selecione Configuração.
  2. Abra a categoria Sistema.
  3. Selecione Webhooks de Notificação.

A página Webhooks de Notificação com a lista de webhooks.

Adicionar um webhook

  1. Selecione Adicionar Webhook.
  2. Em Nome, escreva um nome.
  3. Em URL, escreva o endereço. Deve começar com https://.
  4. Opcional: em Segredo (opcional), escreva um segredo. O AurionAI assina então cada pedido. Deixe em branco para enviar pedidos não assinados.
  5. Escolha os eventos:
    • Para receber todos os eventos de notificação, ative Subscrever todos os eventos.
    • Caso contrário, selecione os eventos na lista.
  6. Selecione Criar.

A mensagem Webhook criado é apresentada. Um novo webhook fica Ativado.

Testar o webhook

  1. No webhook, selecione Testar.
  2. Na caixa de diálogo Enviar um payload de teste?, selecione Enviar teste.

O AurionAI envia imediatamente um evento webhook.test. A mensagem Payload de teste enviado com sucesso ou Payload de teste falhou é apresentada.

Verificar a assinatura

Quando o webhook tem um segredo, cada pedido inclui dois cabeçalhos adicionais:

  • X-Webhook-Timestamp: a hora do pedido, em segundos desde 1 de janeiro de 1970 (UTC).
  • X-Webhook-Signature: sha256= seguido da assinatura.

Para verificar um pedido, calcule um HMAC-SHA256 do timestamp, um ponto e o corpo em bruto, com o seu segredo. Escreva o resultado em hexadecimal. Deve ser igual à parte após sha256=.

Editar, desativar ou eliminar um webhook

  • Para alterar um webhook, selecione Editar Webhook, altere os campos e selecione Guardar. Deixe o segredo em branco para o manter, ou selecione Remover segredo para enviar pedidos não assinados.
  • Para suspender as entregas durante algum tempo, abra Editar Webhook e coloque o interruptor em Desativado. Em seguida, guarde.
  • Para remover um webhook, selecione Eliminar. Na caixa de diálogo Eliminar este webhook?, selecione Eliminar webhook. Esta ação também remove o histórico de entregas e o segredo. Não é possível anular esta operação.
  • Para ver as entregas anteriores, selecione Histórico no webhook. Cada linha mostra Entregue, Falhou ou Ignorado, com o motivo de uma falha.

Resultado

O AurionAI envia cada evento selecionado quando este ocorre. Se o seu endereço não responder, ou responder com um estado 5xx, o AurionAI tenta novamente de imediato, até um total de três tentativas. Uma resposta 4xx é definitiva: o AurionAI não volta a tentar.

Se algo correr mal

  • O URL deve começar por https://. Inicie o endereço com https://.
  • Os endpoints de metadados da cloud estão sempre bloqueados. ou uma mensagem a indicar que um endereço IP se encontra num intervalo bloqueado. O AurionAI não envia webhooks para endereços privados ou internos. Utilize um endereço público.
  • Uma mensagem indica que a resolução de DNS falhou. O nome do anfitrião não existe ou não tem registo DNS. Verifique o endereço.
  • Selecione pelo menos um evento ou escolha «Subscrever todos os eventos». Selecione pelo menos um evento ou ative Subscrever todos os eventos.
  • Payload de teste falhou Leia o motivo, o estado HTTP e o número de tentativas na mensagem. Verifique se o seu recetor está online e responde com um estado 2xx.
  • Este webhook está desativado Ative primeiro o webhook. Se selecionar Enviar mesmo assim, o AurionAI apenas regista uma tentativa ignorada.
  • Uma entrega mostra Ignorado. O webhook estava desativado ou o endereço não passou a verificação de segurança antes do envio. Leia o motivo no histórico.
  • Não foi possível carregar os webhooks ou Não foi possível carregar os eventos de notificação Selecione Tentar novamente.

Artigos relacionados

Ainda precisa de ajuda? Envie um pedido ou .