Creación de Webhooks

Los webhooks ofrecen una forma potente de obtener actualizaciones en tiempo real desde su plataforma Awardco, permitiendo una integración fluida con sus otras aplicaciones. A diferencia de las API tradicionales que requieren que revise constantemente si hay nueva información, los webhooks envían automáticamente datos a la ubicación que usted especifique tan pronto como ocurre un evento relevante en Awardco. Esto garantiza que siempre tenga la información más actualizada, sin demoras.

Actualmente, nuestra función de webhooks se centra en eventos de Reconocimiento, lo que significa que puede recibir datos instantáneamente sobre los reconocimientos a medida que ocurren en Awardco. Estos datos incluyen detalles como el otorgante, el destinatario, la cantidad de puntos, la nota de reconocimiento y el nombre del programa. Este artículo le guiará sobre cómo crear, configurar y administrar webhooks para sincronizar los datos de reconocimiento desde su plataforma Awardco hasta el endpoint que elija.

1. Casos de Uso de Webhooks 
2. Navegando al Creador de Webhooks
3. Creación de un Webhook
4. Administración de Webhooks
5. Preguntas Frecuentes

Caso de Uso de Webhooks 

Los webhooks permiten que su organización muestre actualizaciones de reconocimiento en tiempo real en feeds sociales fuera de la plataforma, como una intranet corporativa.

A diferencia de conectarse mediante llamadas API de feed, el proceso es instantáneo con los webhooks. Tan pronto como se envía un reconocimiento en su plataforma Awardco, se activa el webhook y los datos del reconocimiento se envían inmediatamente a su endpoint especificado, permitiendo actualizaciones instantáneas en sus feeds externos.

Navegando al Creador de Webhooks

Para comenzar a crear y administrar webhooks:

1. Inicie sesión en su plataforma de reconocimiento.
2. En la página principal, seleccione el botón Admin en la parte inferior del menú de navegación izquierdo.
3. Seleccione “Plataforma”, luego “Integraciones” y después “Webhooks” en el menú de navegación izquierdo.

En la página de Webhooks, verá una lista de cualquier webhook existente. Para crear uno nuevo, haga clic en el botón Crear Webhook.

Creación de un Webhook

Cuando haga clic en "Crear Webhook", aparecerá una ventana modal donde podrá configurar su nuevo webhook. Aquí tiene un desglose de cada campo:

• Nombre: Asigne un nombre descriptivo a su webhook. Esto le ayudará a identificarlo más tarde, especialmente si tiene varios webhooks.
• Eventos de Disparo: Este menú desplegable actualmente tiene una opción: Reconocimiento Completo. Esto significa que su webhook se activará cada vez que un reconocimiento se envíe con éxito en Awardco. Estamos abiertos a agregar más tipos de eventos de disparo en el futuro según las solicitudes de los clientes.
• URL del Endpoint: Esta es la URL a la que se enviarán los datos del reconocimiento. Usted es responsable de proporcionar esta URL. Esta es la "ubicación" con la que su webhook se comunicará.
• Clave Secreta: Esta es una medida de seguridad generada automáticamente. Cuando se envía una solicitud de webhook desde Awardco, usted usará esta clave secreta para crear una firma. Esta firma luego se compara con una firma que envía Awardco. Si coinciden, se verifica que los datos provienen genuinamente de Awardco y no de un tercero malintencionado. Para más detalles técnicos sobre cómo generar esta firma, consulte la sección "Verificación de Webhooks" en nuestra documentación API.
• Correos Electrónicos para Errores: Si hay algún problema con la entrega de datos de su webhook, los registros de errores se enviarán a las direcciones de correo electrónico listadas aquí. Puede agregar múltiples direcciones separándolas con comas.
• Estado: Active esta opción para que los datos del evento se entreguen cuando ocurra el evento disparador. Configurarlo como Inactivo pausará el webhook.
• Ejecutar Prueba: Haga clic en este botón para enviar datos de reconocimiento de prueba a su URL de Endpoint especificada. Esto le permite verificar que su webhook esté configurado correctamente antes de que funcione con datos reales. Recuerde eliminar cualquier reconocimiento de prueba que aparezca en su feed externo después de realizar una prueba.

Administración de Webhooks

Una vez que haya creado un webhook, puede administrarlo desde la página principal de Webhooks. Junto a cada webhook, encontrará un menú de tres puntos con las siguientes opciones:

• Ver Detalles: Esta opción muestra información general sobre el webhook, incluyendo la posibilidad de copiar la clave secreta.
• Editar: Esto lo lleva de nuevo a la ventana modal de creación de webhook, donde puede modificar cualquiera de sus configuraciones.
• Ejecutar Prueba: Similar al botón "Ejecutar Prueba" durante la creación, esto envía datos de prueba a su URL de Endpoint para asegurar que el webhook funcione como se espera.
• Establecer Inactivo: Esto pausa el webhook, impidiendo que se active y envíe datos.
• Establecer Activo: (Solo visible si el webhook está inactivo) Esto reactiva el webhook, permitiendo que se active nuevamente.
• Eliminar: Esto elimina permanentemente el webhook.

Preguntas Frecuentes

• P: ¿Cuál es la diferencia entre webhooks y APIs?
  • R: Las APIs normalmente requieren que usted haga solicitudes para obtener datos. Los webhooks, en cambio, son "impulsados por eventos", lo que significa que envían automáticamente datos a su endpoint especificado tan pronto como ocurre un evento particular (como el envío de un reconocimiento). Esto hace que los webhooks sean ideales para actualizaciones en tiempo real.
• P: ¿Puedo obtener webhooks para eventos distintos a "Reconocimiento Completo"?
  • R: Actualmente, "Reconocimiento Completo" es el único evento disparador disponible. Estamos explorando agregar más tipos de eventos en el futuro. Si tiene un caso de uso específico, por favor contacte a su representante de Awardco.
• P: ¿Dónde puedo encontrar más documentación técnica sobre webhooks?
  • R: Nuestra documentación API incluye una sección dedicada a los webhooks, que proporciona más detalles técnicos, incluyendo información sobre cómo generar una firma a partir de su clave secreta para la verificación del webhook. Mientras está en fase beta, esta página se puede acceder directamente en: https://api.awardco.com/api/webhooks

If you have any questions, please contact Awardco Admin Support.