Tutorial: Cómo habilitar la integración con Webhook

¿Qué es un Webhook?

Un Webhook es un sistema utilizado por una aplicación para enviar información en tiempo real a otras aplicaciones. Un webhook envía la información al mismo tiempo en que ésta se registra, lo que significa que te permite obtener la información al momento. 

La integración con Webhooks de Easypromos te permite enviar la información de registro de los usuarios que participan en tus promociones a tu propia aplicación. Este sistema te permite, así, poder recibir la información de registro de los participantes en tiempo real para poder gestionarla, tratarla y manipularla en tu propia aplicación según tus necesidades. 

 

NOTA: La integración con Webhooks está disponible únicamente para las promociones creadas con la versión Marca Blanca de la plataforma.

 

A continuación te explicamos cómo habilitar la integración con Webhook en tu aplicación.

 

¿Qué puedes hacer con la integración con Webhooks?

El sistema Webhooks permite explotar en tiempo real los datos de los usuarios registrados en tus promociones. Las utilidades más frecuentes de la integración con Webhooks son:

  • Para enviar los datos de registro recopilados a través de tus promociones a una aplicación fuera de Easypromos. Por ejemplo, para conectar la base de datos de tus promociones con tu propio sistema CRM.
  • Para juntar la información de dos promociones o más en una misma aplicación. Por ejemplo, para alimentar un microsite con las fotos y participaciones de todos tus concursos.

 

Antes de Empezar

Antes de iniciar el proceso deberás tener en cuenta los siguientes puntos:

  • La Integración con Webhooks es una funcionalidad avanzada y, por lo tanto, se deben tener conocimientos avanzados en programación o bien contar con un desarrollador.
  • Necesitas disponer de un servidor que acepte llamadas POST, así como poder escribir un script que realice una acción como respuesta.
  • Puedes crear una URL de pruebas con Request Bin para comprobar cómo recibirás los datos.

 

Cómo configurar Webhooks

Para configurar la integración con Webhooks deberás seguir estos pasos:

  

1. Accede a la página de gestión de la promoción y haz clic en ‘Integraciones’:

2. A continuación, haz clic en la imagen de ‘Webhooks’ para habilitar la integración:

3. Accederás a la página de configuración de la integración con Webhooks, donde podrás configurar las dos opciones siguientes:

a) Webhook URL: Es la URL donde quieres que enviemos la información registrada a través de la promoción. Si no tienes una URL de devolución de llamada, contacta a tu desarrollador o contacta con un experto para configurarla.

b) Webhook Key (opcional): Opcionalmente puedes añadir una referencia al Webhook a través de este campo de texto alfanumérico. Por ejemplo: puedes utilizar el ID de la promoción o cualquier otra referencia de la promoción como Key para así poder identificarla más fácilmente. Algunas utilidades del Webhook son:

  • Clasificar y distinguir diferentes promociones. Por ejemplo, si tienes habilitada la integración con Webhooks en diferentes promociones que funcionan de forma simultánea, la Webhook Key te permitirá clasificarlas en tu aplicación y distinguirlas más fácilmente.
  • Utilizar la Webhook Key como clave de seguridad para verificar que la llamada la realiza el servidor de Easypromos.

 

¿Qué información se enviará?

Nuestro servidor enviará al momento toda la información de los usuarios que se registren en la aplicación a la URL de Webhook siguiendo el método POST. 

Por lo tanto, cada vez que un usuario complete el formulario de registro de tu promoción, Easypromos enviará la siguiente información a la URL de Webhook que hayas configurado: 

 

Parámetro Descripción
DATA.JSON

La información registrada a través del formulario de registro en formato JSON. Por ejemplo:

{"User":{"id":"618148992","name":"Edgard Massot Casademont","first_name":"Edgard","last_name":"Massot Casademont","fbuid":"1425878509","created":"2016-07-20 17:26:31","public_entry":"0","device":"","date":"Jul.20.2016 17:26"},"Recruiter":[]}

 

KEY

Es el nombre o referencia que has configurado a través del campo 'Webhook Key' en la integración con Webhook de la aplicación Easypromos. 

 

¿Puedo hacer un test para ver cómo recibiré la información?

Sí, puedes testear el comportamiento de tu Webhook antes de lanzar la promoción y empezar a recibir la información de registro de los usuarios reales. Para ello, puedes crear una URL de pruebas con RequestBin para tener una vista preliminar y examinar en qué formato recibirás la información. 

Para ello, sigue estos pasos:

1. Accede a RequestBin y crea un nuevo Request:

2. Accede al apartado Integraciones > Webhooks de la aplicación y en el campo 'Webooks URL' escribe la URL que se acaba de generar en la página RequestBin. Opcionalmente, añade una 'Webhook Key' y, tras guardar los cambios, haz clic en el botón 'Test':

3. En la URL de RequestBin podrás refrescar la página para ver el formato de los datos que se enviarán:

 

4. Si quieres ver el formato de los datos reales que se enviarán, puedes activar la promoción y hacer una prueba en real participando como usuario. Al volver a esta página, verás que el parámetro data.json vendrá ya con datos reales:

 

¿Tiene más preguntas? Enviar una solicitud

0 Comentarios

Inicie sesión para dejar un comentario.