Criando um webhook de notificação

Webhooks de notificação são chamadas de API externas que você usa para enviar dados para uma terceira parte quando ocorrem eventos específicos.

Sobre esta tarefa

Você pode configurar o URL da solicitação da API externa que deseja iniciar e adicionar quaisquer cabeçalhos de parâmetros necessários para iniciar o URL da solicitação. Para obter informações sobre cargas úteis do evento, consulte Tipos de eventos e cargas úteis.

Dentro da JSON de configuração do webhook, uma propriedade notification existe. Essa propriedade é um objeto JSON aninhado que contém todas as opções de configuração específicas da notificação. A propriedade interests é definida dentro deste objeto notification. Quando um evento é gerado, ele é verificado em relação a cada elemento na propriedade interests. Se algum elemento na propriedade interests for avaliado para uma correspondência, o evento será enviado para o destino do webhook. Os interesses são verificados em ordem, por isso em casos de uso de alto desempenho, coloque a partida mais ampla primeiro.

Um interesse consiste em dois campos, um name aliado e uma lista de clauses. Essas cláusulas decidem se o interesse é uma partida ou não. As cláusulas são unidas com uma operação AND , e somente se todas combinarem com o interesse é satisfeita. Uma cláusula consiste em três campos:

  • key
  • value
  • operation -valores válidos são include e exclude.
A chave é um nome de propriedade JSON e é usada para indicar onde no evento para determinar se esta cláusula corresponde. A chave pode ser usada para avaliar teclas ou teclas de alto nível dentro do objeto de dados de um evento. Quando ele referencia o objeto de dados, a notação de ponto JSON é usada, por exemplo data.action. O valor é o valor esperado do campo que está sendo inspecionado. A operação indica se uma correspondência sobre essa cláusula faz com que o evento seja incluído ou excluído.

Por exemplo, quando os eventos de autenticação são o interesse fundamental, mas você deseja filtrar autenticações que ocorrem por meio da federação, use estas cláusulas:

  • Key: event_type, Value: authentication, Operation: include
  • Key: data.subtype, Value: federation, Operation: exclude

Essas cláusulas tornam-se a avaliação lógica:

event_type IS authentication E data.subtype IS NOT federation.

Para obter mais informações, consulte Webhooks de notificação..

Procedimento

  1. Navegue para Integrações > webhooks de notificação.
  2. Clique em Criar webhook.
  3. Forneça um nome para o webhook.
    Também é possível especificar um proprietário e informações de contato por e-mail.
  4. Especifique uma ou mais URLs de solicitação para a API.
  5. Selecione o tipo de autenticação.
    Básico
    Especifique o nome de usuário e a senha.
    Cabeçalho
    Especifique o nome do cabeçalho e o segredo de autenticação. Se o segredo fizer distinção entre maiúsculas e minúsculas, marque a caixa de seleção Distinção entre maiúsculas e minúsculas.
    Nenhum
    Nenhuma informação de autenticação é necessária.
    OAuth
    Especifique o terminal do token, selecione se o segredo do cliente é post ou basic, insira o ID do cliente e o segredo.
    Nota: O post do cliente indica que o segredo é armazenado como um atributo. A configuração básica do cliente indica que o segredo está armazenado no cabeçalho.
    JSON Web Token (JWT)
    Especifique o valor do cabeçalho HTTP, a sub-reivindicação, o tempo de vida máximo válido do JWT e o algoritmo de assinatura. Se desejar, também é possível especificar um prefixo de valor de cabeçalho JWT, chaves de cabeçalho JWT e nomes de solicitação de solicitação.
    TLS mútuo (mTLS)
    Especifique o rótulo certificado MTLS.
  6. Opcional: Digitar quaisquer cabeçalhos e valores customizados.
  7. Opcional: Habilitar Letras mortas.
    O recurso de letras Mortas registra notificações sem sucesso.
    1. Ativar Automaticamente tentativa de reconciliação de letra morta e selecionar o intervalo de reconciliação de tentativas.
      Você pode especificar para reenviar a notificação a cada 5, 15 ou 30 minutes minutos.
  8. Clique em Avançar.
  9. Especifique as inscrições do evento para o seu webhook.
    Quando qualquer um dos eventos que você especificar ocorrer, uma notificação é acionada para o webhook. Selecione um evento predefinido ou inclua um evento personalizado. Você deve especificar pelo menos um evento.
  10. Opcional: Clique em Eventos pré-definidos.
    1. Selecione a caixa de seleção para um ou mais dos eventos pré-definidos.
      • Todos os eventos de autenticação
      • Eventos de autenticação com falha
      • Perfil do usuário modificado
      • Perfil do usuário criado
      Os eventos que você escolher estão listados na área de janela Detalhes para os Eventos selecionados.
    2. Clique em Adicionar.
      Você é voltado para a página Assinatura de eventos e os eventos estão listados na seção Configuração do evento .
  11. Opcional: Clique em Adicionar evento personalizado.
    1. Forneça um nome para o evento.
      Você também pode especificar uma descrição do evento.
    2. Especifique os interesses que acionam o evento.
      Os eventos são um par de propriedade e valor que deve avaliar como true para acionar o evento.
    3. Especifique se deve incluir ou excluir o interesse.
      Você pode especificar event_type authentication include e user.type admin excluir para acionar o webhook em todo evento de autenticação que não é de e admin.
    4. Opcional: Especificar mais interesses.
  12. Clique em Adicionar.
    Você é voltado para a página Assinatura de eventos e o evento é listado na seção Configuração do evento .
  13. Opcional: Adicionar eventos mais customizados.
  14. Clique em Criar.
    O webhook é listado na página Notificação Webhooks e o webhook é exibido.
  15. Opcional: Modifique os eventos do webhook.
    1. Adicionar eventos mais customizados e predefinidos.
    2. Editar os eventos
      1. Selecione o evento que você deseja modificar e clique no ícone de lápis Ícone de edição.
      2. Você pode alterar o nome ou a descrição. Você pode adicionar ou modificar os interesses.
      3. Clique em Atualizar.
    3. Para remover um evento, selecione-o e clique no Remover ícone Placa de subtração dentro de um círculo..
  16. Opcional: Modifique os detalhes da conexão.
    1. Selecione Detalhes da conexão.
    2. Modificar todas as configurações, exceto para Purpose e Versão de integração.
    3. Teste a conexão.
    4. Visualizar o status de funcionamento.
    5. Excluir o webhook.
  17. Se você fez alguma alteração, clique em Salvar alterações.
  18. Clique em Notificação de webhooks para retornar à página Notificação Webhooks .