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:
keyvalueoperation-los valores válidos sonincludeyexclude.
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:includeKey: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.