Los webhooks permiten notificar automáticamente a un sistema externo cada vez que se crea un evento o una observación (o, en el caso de los eventos, también cuando se modifica) en EarthRanger sin necesidad de que dicho sistema compruebe repetidamente si hay actualizaciones.
Antes de comenzar , necesitará acceso de administrador y una URL de destino del sistema al que desea notificar.
- Utilice una URL HTTPS. EarthRanger actualmente no restringe los destinos de webhook a HTTPS, por lo que una URL http:// envía los valores de encabezado configurados, incluidos los tokens, a través de la red sin cifrar.
- No dirija un webhook a una dirección de red interna o privada. Actualmente, la URL de destino no se verifica con direcciones internas, de bucle invertido o de metadatos en la nube, por lo que solo debe utilizarse para un punto final externo al que desee acceder.
- No considere los encabezados de solicitud como un lugar seguro para información confidencial. Los valores de los encabezados se almacenan y se muestran en texto plano en el panel de administración, visible para cualquier persona con acceso de administrador a esa configuración.
Configuración de un webhook de eventos
- En EarthRanger Admin, vaya a Actividad > Webhooks de eventos .
- Verás una lista de tus webhooks de eventos existentes. Selecciona Agregar webhook de evento en la esquina superior derecha.
- Llenar:
- Nombre : para identificar el webhook más adelante.
- Activo : marque esta casilla para activarlo.
- Enviar webhook en — elija Creación de evento , Modificación de evento o Ambos .
- URL : el destino que recibirá los datos del webhook.
- Tipos de eventos : seleccione uno o más tipos de eventos a los que se aplicará este webhook. Déjelo en blanco para aplicarlo a todos los tipos de eventos.
- Encabezados de la solicitud : agregue cualquier par nombre/valor que necesite su sistema receptor (por ejemplo, una clave API).
- Guarda usando una de las siguientes opciones: Guardar , Guardar y añadir otro , o Guardar y continuar editando .
Configuración de un webhook de observación
- En EarthRanger Admin, vaya a Actividad > Webhooks de observación .
- Verás una lista de tus webhooks de observación existentes. Selecciona Agregar webhook de observación en la esquina superior derecha.
- Llenar:
- Nombre : para identificar el webhook más adelante.
- Activo : marque esta casilla para activarlo.
- Enviar webhook en — configurado en Creación de observación .
- URL : el destino que recibirá los datos del webhook.
- Grupos temáticos : seleccione uno o más grupos temáticos a los que se aplicará este webhook. Déjelo en blanco para aplicarlo a todos los grupos temáticos. Al seleccionar un grupo, también se incluyen sus subgrupos.
- Encabezados de la solicitud : agregue cualquier par nombre/valor que necesite su sistema receptor.
- Guarda usando una de las siguientes opciones: Guardar , Guardar y añadir otro , o Guardar y continuar editando .
Qué esperar después de la configuración
Los webhooks no siempre se activan al instante, ya que EarthRanger agrupa todo lo ocurrido desde la última vez que se activó el webhook y lo envía junto. Esto sucede cuando se guarda un evento u observación coincidente, o automáticamente cada 60 segundos, lo que ocurra primero.
Para evitar sobrecargar el sistema receptor, EarthRanger limita la frecuencia de envío de webhooks (dos veces por minuto por defecto) y la cantidad de datos que se envían en cada uno (10 elementos por llamada por defecto). Si la actividad supera la capacidad del sistema, los usuarios recibirán los datos en la siguiente llamada en lugar de perderse. Un breve retraso durante un período de alta demanda es normal y no indica ningún problema con el webhook.
Solución de problemas
Mi webhook no se activa. Comprueba que esté marcado como Activo y confirma que tu filtro de Tipo de evento o Grupo de temas no esté excluyendo involuntariamente la actividad que esperas.
Los datos llegan más tarde de lo previsto. Esto suele deberse a los límites de procesamiento por lotes y de velocidad descritos anteriormente; consulte la sección "Qué esperar tras la configuración".
Necesito que se active al modificar una Observación, no solo al crearla. Actualmente, esto no es compatible con los Webhooks de Observación; solo se activan al crearlos.