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