Creación de un webhook de notificaciones

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

Acerca de esta tarea

Puedes configurar la solicitud URL de la API externa que deseas iniciar y añadir los encabezados o parámetros necesarios para iniciar la solicitud URL. Para obtener información sobre las cargas útiles de los eventos, consulta «Tipos de eventos y cargas útiles ».

En el archivo JSON de configuración del webhook, hay 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 interests propiedad da como resultado una coincidencia, el evento se envía al destino del webhook. Los intereses se comprueban por orden, por lo que, en casos de uso que requieran un alto rendimiento, es recomendable colocar primero el que tenga la coincidencia más amplia.

Un interés consta de dos campos, un name descriptivo y una lista de clauses. Estas cláusulas determinan si el interés coincide o no. Las cláusulas se unen mediante una AND operación, y solo si todas se cumplen 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 el nombre de una propiedad JSON y se utiliza para indicar en qué parte del evento se debe 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 evento. data.actionCuando se hace referencia al objeto de datos, se utiliza la notación de puntos de JSON, por ejemplo,. 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 evento se incluya o se excluya.

Por ejemplo, cuando el interés principal son los eventos de autenticación, pero se desea excluir 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:

federationevent_type ES authentication Y data.subtype NO ES.

Para obtener más información, consulta «Webhooks de notificaciones ».

Procedimiento

  1. Ve a Integraciones > Webhooks de notificaciones.
  2. Haz clic en «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 del encabezado « HTTP », la subreclamación, la duración máxima válida del JWT y el algoritmo de firma. Si lo deseas, también puedes especificar un prefijo para los valores de los encabezados JWT, así como las claves de los encabezados JWT y los nombres de las reclamaciones.
    Mutual TLS ( mTLS )
    Especifique la etiqueta del certificado MTLS.
  6. Opcional: Introduce los encabezados y valores personalizados que desees.
  7. Opcional: Activar las direcciones de rebote.
    La sección «Mensajes no entregados» recoge los avisos de entrega fallidos.
    1. Active la opción «Intentar automáticamente la reconciliación de mensajes no entregados» y seleccione el intervalo de reconciliación.
      Puedes configurar que la notificación se reenvíe cada 5, 15 o 30 minutos.
  8. Haga clic en Siguiente.
  9. Especifica las suscripciones a eventos para tu webhook.
    Cuando se produzca cualquiera de los eventos que especifiques, se activará una notificación para el webhook. Selecciona un evento predefinido o añade un evento personalizado. Debes especificar al menos un evento.
  10. Opcional: Haz clic en «Eventos predefinidos ».
    1. Marque la casilla de uno o varios de los eventos predefinidos.
      • Todos los sucesos de autenticación
      • Sucesos de autenticación fallida
      • Perfil de usuario modificado
      • Perfil de usuario creado
      Los eventos que elijas aparecerán en el panel «Detalles» de los eventos seleccionados.
    2. Haz clic en «Añadir ».
      Volverás a la página de suscripción a eventos y estos aparecerán en la sección de configuración de eventos.
  11. Opcional: Haz clic en «Añadir evento personalizado ».
    1. Introduce un nombre para el evento.
      También puedes añadir una descripción del evento.
    2. Especifica los intereses que activan el evento.
      Los eventos son un par formado por una propiedad y un valor que debe evaluarse como verdadero para que se active el evento.
    3. Indique si desea incluir o excluir los intereses.
      Puedes especificar event_type authentication «include» y user.type admin «exclude» para que se active el webhook cada vez que se produzca un evento de autenticación que no provenga de un administrador.
    4. Opcional: Indica más intereses.
  12. Haz clic en «Añadir ».
    Volverás a la página de suscripción al evento y este aparecerá en la sección de configuración del evento.
  13. Opcional: Añade más eventos personalizados.
  14. Haz clic en «Crear ».
    El webhook aparece en la página «Webhooks de notificación» y se muestra el webhook.
  15. Opcional: Modifica los eventos del webhook.
    1. Añade más eventos personalizados y predefinidos.
    2. Editar los eventos
      1. icono de EdiciónSelecciona el evento que quieras modificar y haz clic en el icono del lápiz.
      2. Puedes cambiar el nombre o la descripción. Puedes añadir o modificar los intereses.
      3. Haz clic en «Actualizar ».
    3. Signo de resta dentro de un círculoPara eliminar un evento, selecciónalo y haz clic en el icono Eliminar.
  16. Opcional: Modifica los datos de conexión.
    1. Selecciona «Detalles de la conexión ».
    2. Modifica todos los ajustes, excepto «Propósito » y «Versión de integración ».
    3. Pruebe la conexión.
    4. Ver el estado de salud.
    5. Elimina el webhook.
  17. Si has realizado algún cambio, haz clic en «Guardar cambios ».
  18. Haz clic en «Webhooks de notificaciones» para volver a la página «Webhooks de notificaciones ».