Resumen
Los webhooks (Web Hooks) permiten que KnowledgeCity notifique automáticamente a los sistemas externos cuando ocurren eventos de integración. Usted registra una URL de endpoint, elige qué eventos debe recibir, y KnowledgeCity envía una solicitud firmada a esa URL cada vez que ocurre un evento coincidente. Esto permite que las aplicaciones dependientes reaccionen casi en tiempo real en lugar de consultar repetidamente en busca de cambios.
Introducción
La mayoría de las organizaciones ejecutan KnowledgeCity junto con otros sistemas, y esos sistemas a menudo necesitan saber cuándo cambia algo. Los webhooks proporcionan un canal de notificación saliente: en lugar de que una herramienta externa le pida a KnowledgeCity actualizaciones según un calendario, KnowledgeCity envía un evento a la herramienta en el momento en que ocurre.
Los webhooks los configuran administradores y responsables de integraciones, las personas encargadas de conectar KnowledgeCity con el resto de la pila tecnológica. Resuelven el problema de mantener los sistemas externos sincronizados con los eventos a medida que ocurren, de forma confiable y segura, sin introducción manual de datos ni consultas constantes.
Conceptos clave
- Web Hook: una notificación saliente que KnowledgeCity envía a una URL externa cuando ocurre un evento definido, para que otro sistema pueda reaccionar automáticamente al cambio.
- Endpoint URL (URL de endpoint): la dirección externa que usted controla y que recibe las solicitudes de notificación. Debe poder aceptar y verificar las solicitudes entrantes.
- Events (eventos): las ocurrencias de integración específicas a las que suscribe un endpoint; KnowledgeCity envía una solicitud solo cuando ocurre un evento coincidente.
- HMAC signature (firma HMAC): cada solicitud saliente está firmada con HMAC para que el sistema receptor pueda verificar que el mensaje realmente proviene de KnowledgeCity y no ha sido manipulado.
- Retries with back-off (reintentos con retroceso): si una entrega no tiene éxito, KnowledgeCity reintenta con retroceso exponencial, haciendo que la entrega sea confiable incluso cuando el endpoint no está disponible brevemente.
- Audit log (registro de auditoría): un registro que conserva cada intento de entrega, para que pueda revisar qué se envió y confirmar la recepción o diagnosticar fallos.
Pasos a seguir
Abrir la configuración de Web Hooks
Inicie sesión como administrador y abra el área de Integrations desde la configuración de su cuenta. Desde aquí puede gestionar los webhooks salientes de su cuenta junto con sus otros puntos de conexión.
Registrar una URL de endpoint
En la sección de Web Hooks, registre la endpoint URL externa que debe recibir las notificaciones de eventos. Use un endpoint que usted controle y que esté preparado para aceptar solicitudes entrantes a través de HTTPS. Debido a que las notificaciones se envían a esta dirección a medida que ocurren los eventos, el endpoint debe ser accesible y capaz de responder con prontitud.
Seleccionar qué eventos recibir
Elija sobre qué events debe notificarse al endpoint. KnowledgeCity envía una solicitud a su endpoint solo cuando ocurre uno de los eventos seleccionados, así que suscribirse solo a los eventos que le importan a su sistema externo mantiene el tráfico enfocado y relevante.
Verificar las entregas firmadas
Cada solicitud saliente está firmada con HMAC. En el lado receptor, verifique esta firma antes de actuar sobre una notificación para confirmar que la solicitud realmente se originó en KnowledgeCity y no ha sido alterada en tránsito. Rechazar las solicitudes que fallan en la verificación de firma protege su endpoint de mensajes falsificados o manipulados.
Confiar en los reintentos y revisar el registro de auditoría
La entrega está diseñada para ser confiable. Si su endpoint no está disponible temporalmente, KnowledgeCity reintenta con retroceso exponencial en lugar de descartar la notificación. Para confirmar qué se envió y cuándo, revise el audit log, que conserva cada intento de entrega para que pueda verificar la recepción exitosa o investigar cualquier fallo.
Conclusión
Los webhooks brindan a los administradores una forma confiable de enviar eventos de integración a los sistemas que dependen de ellos. Al registrar una URL de endpoint confiable, suscribirla a los eventos correctos, verificar la firma HMAC en cada solicitud, y confiar en los reintentos automáticos y el registro de auditoría, puede mantener los sistemas externos sincronizados casi en tiempo real mientras mantiene la entrega segura y verificable.