Creación de un webhook de notificación

Los webhooks de notificación son llamadas de API externas que se utilizan para enviar datos a un tercero cuando se producen sucesos específicos.

Acerca de esta tarea

Puede configurar la URL solicitud de la API externa que desea iniciar y añadir las cabeceras de los parámetros necesarios para iniciar la URL solicitud. Para obtener información sobre las cargas útiles de eventos, consulte Tipos de eventos y cargas útiles.

Dentro del JSON de configuración de webhook, existe una propiedad notification . Esta propiedad es un objeto JSON anidado que contiene todas las opciones de configuración específicas de la notificación. La propiedad interests se define en este objeto notification. Cuando se genera un suceso, se comprueba en cada elemento de la propiedad interests. Si algún elemento de la propiedad interests se evalúa como una coincidencia, el suceso se envía al destino de webhook. Los intereses se comprueban en orden, por lo que en casos de uso de alto rendimiento, anteponer el partido más amplio.

Un interés consta de dos campos, un name descriptivo y una lista de clauses. Estas cláusulas deciden si el interés es un partido o no. Las cláusulas se unen con una operación AND y sólo si todas coinciden se satisface el interés. Una cláusula consta de tres campos:

  • key
  • value
  • operation -los valores válidos son include y exclude.
La clave es un nombre de propiedad JSON y se utiliza para indicar dónde en el suceso para determinar si esta cláusula coincide. La clave se puede utilizar para evaluar claves de nivel superior o claves dentro del objeto de datos de un suceso. Cuando hace referencia al objeto de datos, se utiliza la notación de puntos JSON, por ejemplo, data.action. El valor es el valor esperado del campo que se está inspeccionando. La operación indica si una coincidencia en esta cláusula hace que el suceso se incluya o excluya.

Por ejemplo, cuando los sucesos de autenticación son el interés clave, pero desea filtrar las autenticaciones que se producen a través de la federación, utilice estas cláusulas:

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

Estas cláusulas se convierten en la evaluación lógica:

event_type ES authentication Y data.subtype NO ES federation.

Para obtener más información, consulta Webhooks de notificación.

Procedimiento

  1. Navega a Integraciones > Webhooks de notificación.
  2. Pulse Crear webhook.
  3. Proporcione un nombre para el webhook.
    También puede especificar un propietario e información de contacto de correo electrónico.
  4. Especifique uno o más URL de solicitud para la API.
  5. Seleccione el tipo de autenticación.
    Básica
    Especifique el nombre de usuario y la contraseña.
    Cabecera
    Especifique el nombre de cabecera y el secreto de autenticación. Si el secreto distingue entre mayúsculas y minúsculas, marque el recuadro de selección Distinción entre mayúsculas y minúsculas.
    Ninguna
    No es necesaria ninguna información de autenticación.
    OAuth
    Especifique el punto final de señal, seleccione si el secreto de cliente es POST o básico, especifique el ID de cliente y el secreto.
    Nota: La publicación del cliente indica que el secreto se almacena como un atributo. El cliente básico indica que el secreto se almacena en la cabecera.
    Señal web JSON (JWT)
    Especifique el valor de la cabecera HTTP, la sub-reclamación, la vida útil máxima válida del JWT y el algoritmo de firma. Si lo desea, también puede especificar un prefijo de valor de cabecera JWT, claves de cabecera JWT y nombres de reclamación.
    TLS mutuo (mTLS)
    Especifique la etiqueta de certificado MTLS.
  6. Opcional: Introduzca los encabezados y valores personalizados que desee.
  7. Opcional: Habilitar mensajes no entregados.
    La característica de cartas muertas registra notificaciones no satisfactorias.
    1. Habilitar Intentar automáticamente la conciliación de mensajes no entregados y seleccionar el intervalo de conciliación de intentos.
      Puede especificar que se reenvíe la notificación cada 5, 15 o 30 minutos.
  8. Haga clic en Siguiente.
  9. Especifique las suscripciones de sucesos para el webhook.
    Cuando se produce cualquiera de los sucesos que especifique, se desencadena una notificación para el webhook. Seleccione un suceso predefinido o añada un suceso personalizado. Debe especificar al menos un suceso.
  10. Opcional: Haga clic en Eventos predefinidos.
    1. Seleccione el recuadro de selección para uno o varios de los sucesos predefinidos.
      • Todos los sucesos de autenticación
      • Sucesos de autenticación fallida
      • Perfil de usuario modificado
      • Perfil de usuario creado
      Los sucesos que elija se listan en el panel Detalles para los Sucesos seleccionados.
    2. Pulse Añadir.
      Volverá a la página Suscripción de sucesos y los sucesos se listarán en la sección Configuración de sucesos .
  11. Opcional: Haga clic en Añadir evento personalizado.
    1. Proporcione un nombre para el suceso.
      También puede especificar una descripción del suceso.
    2. Especifique los intereses que desencadenan el suceso.
      Los sucesos son una propiedad y un par de valores que deben evaluarse como verdaderos para desencadenar el suceso.
    3. Especifique si desea incluir o excluir el interés.
      Puede especificar event_type authentication include y user.type admin exclude para desencadenar el webhook en cada suceso de autenticación que no sea de y admin.
    4. Opcional: Especifique más intereses.
  12. Pulse Añadir.
    Volverá a la página Suscripción de suceso y el suceso se listará en la sección Configuración de suceso .
  13. Opcional: Añadir más eventos personalizados.
  14. Pulse Crear.
    El webhook se lista en la página Webhooks de notificación y se muestra el webhook.
  15. Opcional: Modificar los eventos del webhook.
    1. Añadir más sucesos personalizados y predefinidos.
    2. Editar los sucesos
      1. Selecciona el evento que deseas modificar y haz clic en el icono del icono de Ediciónlápiz.
      2. Puede cambiar el nombre o la descripción. Puede añadir o modificar los intereses.
      3. Pulse Actualizar.
    3. Para eliminar un evento, selecciónelo y haga clic en el icono Signo de resta dentro de un círculoEliminar.
  16. Opcional: Modifica los detalles de la conexión.
    1. Seleccione Detalles de conexión.
    2. Modificar todos los valores excepto para Propósito y Versión de integración.
    3. Pruebe la conexión.
    4. Ver el estado de salud.
    5. Suprimir el webhook.
  17. Si ha realizado algún cambio, pulse Guardar cambios.
  18. Pulse Webhooks de notificación para volver a la página Webhooks de notificación .