Criação de um webhook de notificação

Editar online

Os webhooks de notificação são chamadas de API externas que você utiliza para enviar dados a um terceiro quando ocorrem eventos específicos.

Sobre esta tarefa

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

No JSON de configuração do webhook, existe uma propriedade notification . 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 da interests propriedade for considerado uma correspondência, o evento é enviado para o destino do webhook. Os interesses são verificados em ordem; portanto, em casos de uso que exigem alto desempenho, coloque a correspondência mais ampla em primeiro lugar.

Um interesse consiste em dois campos, um name aliado e uma lista de clauses. Essas cláusulas determinam se o interesse é compatível ou não. As cláusulas estão ligadas por uma AND operação, e somente se todas elas forem atendidas é que o interesse será satisfeito. Uma cláusula consiste em três campos:

  • key
  • value
  • operation - os valores válidos são include e exclude.
A chave é um nome de propriedade JSON e é usada para indicar em que parte do evento se deve determinar se esta cláusula corresponde. A chave pode ser usada para avaliar chaves de nível superior ou chaves dentro do objeto de dados de um evento. data.actionAo fazer referência ao objeto de dados, utiliza-se a notação de pontos do JSON, por exemplo,. O valor é o valor esperado do campo que está sendo inspecionado. A operação indica se uma correspondência nesta cláusula faz com que o evento seja incluído ou excluído.

Por exemplo, quando o foco principal são os eventos de autenticação, mas você deseja excluir as 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 resultam na seguinte avaliação lógica:

federationevent_type É authentication E data.subtype NÃO É.

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

Procedimento

  1. Acesse 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.
    Header
    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.
    Observação: a publicação 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 validade máximo do JWT e o algoritmo de assinatura. Se desejar, você também pode especificar um prefixo para os valores dos cabeçalhos JWT, bem como as chaves dos cabeçalhos JWT e os nomes das reivindicações.
    Mutual TLS ( mTLS )
    Especifique o nome do certificado MTLS.
  6. Opcional: insira quaisquer cabeçalhos e valores personalizados.
  7. Opcional: Ativar mensagens não entregues.
    A seção "Mensagens não entregues" contém registros de notificações malsucedidas.
    1. Ative a opção “Tentar automaticamente a reconciliação de mensagens não entregues” e selecione o intervalo entre as tentativas de reconciliação.
      Você pode definir para que a notificação seja reenviada a cada 5, 15 ou 30 minutos.
  8. Clique em Avançar.
  9. Especifique as assinaturas de eventos para o seu webhook.
    Quando ocorrer qualquer um dos eventos que você especificar, será acionada uma notificação para o webhook. Selecione um evento predefinido ou adicione um evento personalizado. É necessário especificar pelo menos um evento.
  10. Opcional: Clique em “Eventos predefinidos ”.
    1. Marque a caixa de seleção de um ou mais dos eventos predefinidos.
      • 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ê selecionar serão exibidos no painel "Detalhes" dos eventos selecionados.
    2. Clique em Adicionar.
      Você será redirecionado para a página de assinatura de eventos, e os eventos serão listados na seção de configuração de eventos.
  11. Opcional: Clique em “Adicionar evento personalizado ”.
    1. Insira um nome para o evento.
      Você também pode especificar uma descrição do evento.
    2. Especifique os interesses que desencadeiam o evento.
      Os eventos são um par de propriedade e valor que deve ser avaliado como verdadeiro para acionar o evento.
    3. Especifique se deseja incluir ou excluir os juros.
      Você pode especificar event_type authentication incluir e user.type admin excluir para acionar o webhook sempre que ocorrer um evento de autenticação que não seja de um administrador.
    4. Opcional: Indique mais interesses.
  12. Clique em Adicionar.
    Você será redirecionado para a página de inscrição no evento, e o evento aparecerá na seção de configuração do evento.
  13. Opcional: Adicione mais eventos personalizados.
  14. Clique em Criar.
    O webhook está listado na página "Webhooks de notificação" e é exibido.
  15. Opcional: Modifique os eventos do webhook.
    1. Adicione mais eventos personalizados e predefinidos.
    2. Editar os eventos
      1. Ícone de ediçãoSelecione o evento que deseja modificar e clique no ícone do lápis.
      2. Você pode alterar o nome ou a descrição. Você pode adicionar ou alterar os interesses.
      3. Clique em Atualizar.
    3. Sinal de subtração dentro de um círculoPara excluir um evento, selecione-o e clique no ícone "Excluir".
  16. Opcional: Modifique os detalhes da conexão.
    1. Selecione "Detalhes da conexão".
    2. Altere todas as configurações, exceto “Finalidade ” e “Versão da integração ”.
    3. Teste a conexão.
    4. Verificar o estado de saúde.
    5. Exclua o webhook.
  17. Se você fez alguma alteração, clique em “Salvar alterações ”.
  18. Clique em “Webhooks de notificação” para voltar à página “Webhooks de notificação ”.