Webhooks #

Los webhooks se pueden utilizar para generar notificaciones externas de cambios en el usuario y/o cliente. Estas notificaciones, cuando se combinan con el REST API son esenciales para automatizar el aprovisionamiento de usuarios y mantener actualizados los sistemas externos de configuración/facturación.

Los eventos de webhook se desencadenarán para eventos C.R.U.D en los usuarios y clientes. El REST API A continuación, la aplicación receptora puede utilizarla para consultar la información específica sobre los cambios mediante los identificadores proporcionados en la carga útil del webhook.

Parámetros #

Parámetro	Opciones	Descripción
Tipo de entidad	Usuario, Cliente	La entidad para la que se puede activar el desencadenador. Cree varios disparadores para capturar los cambios de usuario y cliente.
Evento	Creado / Actualizado / Eliminado	Seleccione uno o más tipos de eventos en los que se activará el desencadenador. *Nota: El tipo de evento que provoca un desencadenador está incluido en la carga útil.
URL	https://	Proporcione un HTTPS URL que el disparador llamará cuando se dispare.
Método de solicitud	GET, POST, PUT	Elija el método de solicitud requerido para el webhook.
Formato de solicitud	JSON, Datos del formulario	Elija el formato de solicitud requerido para el webhook si POST o PUT se seleccionan como método de solicitud.
Datos de carga útil adicionales	Par clave-valor	Si es necesario, se puede agregar información estática adicional a la carga útil del webhook. Introduzca los datos adicionales como pares clave-valor, según sea necesario.
Intentos de reintento	0 - 10	Por defecto 1. Introduzca el número de veces que el webhook debe volver a intentarlo si en algún momento hay un error

warning
La configuración del desencadenador de webhook se almacena en caché para mejorar el rendimiento. Los nuevos activadores o los cambios en los activadores existentes pueden tardar hasta 10 minutos en surtir efecto.

info
El tiempo de espera de una solicitud de webhook es de 10 segundos. El tiempo entre reintentos es igual a Número de intento x 2 segundos

Datos de carga útil #

En la tabla siguiente se muestran los datos proporcionados en la carga útil del desencadenador.

Parámetro	Descripción
triggerID	El identificador único del desencadenador para el que se desencadena la solicitud de webhook.
identificación	El identificador de la entidad que está cambiando (ID de usuario o ID de inquilino).
tenantId	El identificador de inquilino del cliente al que está asociado el evento.
eventType	El tipo de evento que genera el webhook. Ya sea crear, Actualización o eliminar
customData	Si se configura con el desencadenador, cualquier información adicional del par clave/valor de carga útil se pasará aquí.

tip
El triggerId se puede encontrar editando un desencadenador configurado en el Portal de revendedor y copiando el archivo GUID Desde el final de la URL. p. ej. https://reseller.myreports.com/en-GB/webhooks/00000000-0000-0000-0000-000000000000

Ejemplo JSON carga útil: #

Ejemplo JSON Formato de carga útil para PUT/POST Solicitudes:

{
    "triggerId": "00000000-0000-0000-0000-000000000000",
    "id": "1468547c-a945-41d4-95e3-ffffffffffff",
    "tenantId": "a0ea7445-df78-4487-ffffffffffff",
    "configurationType": "user",
    "eventType": "update",
    "customData": {
        "myitemkey1": "myitemval1",
        "myitemkey2": "myitemval2"
    }
}

Ejemplo de carga útil de datos de FORM #

Ejemplo de carga útil de datos de formulario para PUT/POST Solicitudes:

[triggerId, 00000000-0000-0000-0000-000000000000], [tenantId, a0ea7445-df78-4487-ffffffffffff], [id, 1468547c-a945-41d4-95e3-ffffffffffff], [configurationType, user], [eventType, update],[myitemkey1, myitemval1], [myitemkey2, myitemval2]

Ejemplo GET pedir #

Si el método Request de GET está configurado para el webhook, los datos de carga se pasan como parámetros de cadena de consulta en la solicitud.

http://example.url.com?triggerId=00000000-0000-0000-0000-000000000000&tenantId=a0ea7445-df78-4487-ffffffffffff&id=1468547c-a945-41d4-95e3-ffffffffffff&configurationType=user&eventType=update&hook=get&myitemkey1=myitemval1&myitemkey2=myitemval2