Webhooks

Aprenda a crear y personalizar los Webhooks en su Programa de Referidos

¿Qué es un Webhook?
Los webhooks son "devoluciones de llamada HTTPS definidas por el usuario" activadas por eventos en este caso desde su Programa de Referidos con Genius Referrals.

Algunos aspectos a tener en cuenta:

  • Se envía un HTTPS POST a cada URL de suscripción con datos relevantes, en formato JSON, cuando se activa un evento, por ejemplo, al registrar un nuevo miembro, bono o recompensa.
  • Al suscribirse a un Webhook, su aplicación puede ejecutar código inmediatamente después de que ocurran eventos específicos en su Programa de Referidos.
  • Se considera una entrega de un Webhook como "entregado correctamente" cuando Genius recibe un estado de respuesta 200. De lo contrario se reintenta entregar continuamente el Webhook después de un intervalo de tiempo determinado. Por 48 horas se reintenta entregar el Webhook, durante este período Genius intenta entregar el Webhook 20 veces en total:
1- Se espera 2 segundos al enviar si no hay respuesta o da error, Genius vuelve a intentar 4 veces en el primer minuto es decir cada 15 segundos y así hasta 1 minuto.
2- Las restantes 16 veces se enviaran en grupos de a 4 con 1 hora y media de diferencia entre cada grupo. El primer grupo se enviarán cada 1 hora y media y las 4 últimas cada 4 horas y media.
Tenga en cuenta: Para realizar pruebas a esta integración existen varios servicios en línea que puede utilizar para crear URLs de carga, como:
Creación de un Webhook
Al adicionar un webhook se enviará una solicitud POST a la URL que defina con detalles de cada evento seleccionado. Para crear un webhook primero debe:

  1. Iniciar sesión en su cuenta de Genius Referrals .
  2. Haga clic en la sección Integración ubicada en el menú de navegación del lado izquierdo.
  3. Desde ahí, dará clic en Webhooks, y luego en Agregar webhook. Siga los pasos a continuación para crear el webhook.

Información General

  • URL de Carga
Debe introducir la URL del servidor que recibirá las solicitudes POST del webhook.

  • Tipo de contenido
A continuación, debe seleccionar que tipo de contenido en que se entregara el contenido, pueden entregarse utilizando diferentes tipos de contenido:

  • El tipo de contenido en formato application/json.
  • El tipo de contenido en formato application/x-www-form-urlencoded.

Seguridad


  • Secreto
El secreto le permite asegurarse de que las solicitudes POST enviadas a la URL de carga útil provengan de Genius Referrals. Recibirá el encabezado X-Genius-Referrals-Signature-256 en la solicitud POST del webhook.

  • Verificación SSL
Si tu "URL de Carga" es un sitio seguro (HTTPS), deberás configurar los ajustes de verificación de SSL. En este caso tendrás dos opciones Habilitar e Inhabilitar la verificación SSL. Si tu URL no es segura (HTTP) esta opción no se mostrará. Se recomiendo siempre dejar habilitada.

Eventos

Los eventos son el núcleo de los webhooks. Estos webhooks se activan cada vez que se realiza una determinada acción en su programa de referidos, los cuales son interceptados y procesado por la URL de Carga de su servidor.

  • Activo
Indica si el Webhook esta activo o no. Puedes elegir inhabilitar la entrega de cargas de webhooks si deseleccionas "Activo".

Cuando termine, haga clic en el botón Guardar.
Edición y Eliminación de un Webhook
Los Webhooks se mostrarán en un listado en el cual podrá Editar y Eliminar respectivamente.

  1. Busca el Webhook que deseas modificar.
  2. Haga click en los tres puntos (...) y aparecerán las opciones Editar y Eliminar.
  3. En el caso de Editar siempre recuerde guardar los cambios.
  4. Para Eliminar siempre se le pedirá confirmación antes de realizar la acción.
Entregas Recientes
Los Webhooks se mostrarán en un listado en el cual desde las acciones de cada Webhook podrá visualizar las Entregas.

  1. Busca el Webhook que deseas visualizar.
  2. En las acciones (...) aparecerán varias opciones. Haga clic en Entregas Recientes.
  3. Se mostrará un listado de todas las entregas realizadas ordenadas por fecha de entrega y el estado (Enviado, Reenviado, Fallo el envío respectivo de cada entrega.
Enviado
Reenviado
Fallo el Envío
Detalles de la Entrega
Dentro de la lista de entregas podrás visualizar los detalles individuales de cada entrega. Incluyendo la solicitud y la respuesta. Haga clic en los tres puntos (...) y luego en Ver Detalles.

  • Solicitud
La pestaña Solicitud te proporciona información de los Encabezados que se enviaron y los detalles acerca de la Carga.

  • Respuesta
La pestaña de respuesta lista la forma en que tu servidor respondió una vez que recibió la entrega y el código de estado de la respuesta. Te proporciona información de los Encabezados y cualquier dato adicional dentro del Cuerpo de la respuesta.
  • Volver a Entregar un Webhook
Si falla un envío, automáticamente el sistema lo enviará nuevamente teniendo en cuenta la frecuencia ya establecida en el sistema. Si desea reenviar la entrega nuevamente lo puede hacer siguiendo los siguientes pasos:

1- Dentro de la propia sección de detalles de entrega, haga clic en el evento "Volver a Entregar" para que se envié el evento de ese webhook nuevamente.
2- Confirmar la acción, recuerde que siempre se le pedirá confirmación antes de realizar la acción.
¿Fue útil esta página?
English
LANGUAGE