Acerca de los webhooks en ClearID - ClearID

Guía del Usuario de Genetec ClearID™

Product
ClearID
Content type
Guías > Guías del usuario
Language
Español
Last updated
2024-09-18

Un webhook es una devolución de llamada HTTP definida por el usuario. Un webhook puede ser activado por un evento en una aplicación web y usarse para enviar datos o notificaciones a una Interfaz de Programación de Aplicaciones (API, por sus siglas en inglés) de terceros.

Webhooks en Genetec ClearID™

En ClearID, se puede crear y utilizar webhooks para notificar a las API de terceros cuando se produzcan eventos específicos.
Página de webhooks en ClearID que muestra el nombre, la URL, el Evento, la Descripción y el Estado de los webhooks.

Por ejemplo, se podría enviar una notificación por correo electrónico con un enlace a información detallada sobre una identidad cuando se produzca un evento de Identidad actualizada, o si requiere que se notifique a otras partes interesadas después de que se produzca un evento de Solicitudes de identidad creadas o Solicitudes de identidad actualizadas.

Procesamiento de webhook

Después de que se crea el webhook, el servicio de webhook escucha un subconjunto de eventos específicos provenientes de otros servicios de ClearID. Cuando ocurre el evento especificado, el servicio de webhook notifica a la API especificada en el campo de URL de la sección de Detalles del webhook.

Esquemas de eventos de webhook

El esquema describe el objeto que se envía a través del webhook y su contenido varía según el tipo de evento especificado. El esquema de eventos de webhook se puede descargar desde la sección de Evento del webhook para ayudar a comprender la estructura de datos de los eventos para que puedan recuperarse y procesarse de forma correcta del lado del usuario de la integración del webhook.

Página de detalles de webhooks en ClearID en la que se muestra un evento de Identidad creada con el botón Descargar esquema resaltado.

Para obtener más información sobre cómo descargar el esquema, consulte Creación de webhooks en ClearID.

Registros de webhook

Los propietarios de API de terceros pueden usar los registros de webhooks para verificar el estado de cada solicitud de devolución de llamada HTTP enviada a la URL de terceros y para solucionar problemas de webhooks no recibidos u otros problemas asociados. Por ejemplo, problemas del remitente, problemas del receptor, etc.

Los registros de webhook incluyen lo siguiente:
Fecha de devolución de llamada
Cuándo se envió la devolución de llamada (incluye filtros de intervalo de fechas).
URL
La URL usada para reenviar la notificación del evento de webhook a la API de terceros correspondiente (programa o aplicación).
Respuesta
El estado de respuesta indica si la API de terceros recibió la devolución de llamada HTTP de forma correcta o no. Por ejemplo, solicitud aceptada, incorrecta, error interno del servidor, etc.
Sección de registros de la página de detalles de un webhook en ClearID en el que se muestra la fecha de devolución de llamada, la URL y el Estado de respuesta.
NOTA: La sección de Registros del webhook solo se muestra al final de los detalles del webhook después de que se haya producido la primera devolución de llamada.