6.2. Eventos en curso
1. Qué son los Webhooks?
❗️Esta funcionalidad requiere conocimientos de programación.
Si necesitas realizar una integración, recomendamos que envíes esta guía al informático o persona que gestiona tus sistemas.
En pocas palabras, los Webhooks son eventos que desencadenan acciones.
Su nombre se debe a que funcionan como "ganchos" de los programas en Internet y casi siempre se utilizan para la comunicación entre sistemas a tiempo real.
Son la manera más sencilla de obtener un aviso cuando algo ocurre en otro sistema, como del entorno de tu cuenta Stockcrowd a un CRM.
2. Webhooks en Stockcrowd (POST)
❗️El tipo de codificación para cualquier evento es UTF-8
Una vez se genere un evento en Stockcrowd, se enviarán los datos asociados:
A través de un correo electronico (Email).
A través de una petición POST a una URL definida por usted-
Los datos que se enviarán dependerán del tipo de Evento ocurrido.
Los pasos para definir un evento son los siguientes:
Seleccionar el tipo de evento a configurar
Configurar la notificación, a través de una url o de un correo electrónico
Activar la notificación
Una vez el Webhook esté activado, StockCrowd lanzará notificaciones siempre que pase este evento, colocando los datos en la URL o en el Correo elegidos.
3. Tipos de Eventos en Stockcrowd
Stockcrowd tiene los siguientes tipos de eventos disponibles:
Event type | Description |
|
INVERSOR_CREATED | Registro de usuario completado |
|
INVERSOR_PAYMENT_CREATED | Se ha creado una solicitud de pago |
|
INVERSOR_PAYMENT_SUCCEEDED | Solicitud de pago confirmada |
|
RECOMPENSA_SOLD | Datos de una recompensa asociados a un pago exitoso |
|
BLACKBAUD_TOKENIZATION | Captación de fondos utilizando BLACKBAUD en modalidad de tokenización |
|
SIGNATURE_CREATED | Registro de recogida de firma asociada a una campaña |
|
CAMPAIGN_ACTIVATED | Activación de Campaña |
|
INVERSOR_PAYMENT_REFUND | Devolución de la solicitud confirmada |
|
INVERSOR_PAYMENT_SUBSCRIPTION_CANCELLED | Cancelación de la suscripción al cargo recurrente |
|
INVERSOR_PAYMENT_SUBSCRIPTION_CHANGED | Cambios en la suscripción del cargo recurrente |
|
RECURRING_CHARGE_CREATED | Cargo recurrente creado |
|
INVERSOR_PAYMENT_SUBSCRIPTION_FAILED | Pago fallido en el cargo de la subscripción recurrente |
|
P2P_CAMPAIGN_CREATED | Reto de campaña creado |
|
P2P_CAMPAIGN_UPDATED | Reto de campaña actualizado |
|
P2P_CAMPAIGN_APPROVED | Reto de campaña aprobado |
|
INVERSOR_PAYMENT_ABANDONED | Solicitud de pago abandonada por el usuario. |
|
👉 Para más informaciones de configuración de los eventos, visite el apartado Organización > Eventos en tu cuenta Stockcrowd, y selecciona el tipo de Evento que quieres configurar.
4. Como Configurar Webhooks (Eventos)
Para configurar un Webhook, debes acceder al apartado Organización, y seleccionar la pestaña Eventos.
Verás en este apartado el listado de eventos disponibles.
Selecciona el tipo de Evento que quieres recibir informaciones para ver más informaciones, y para abrir más opciones en configuración:
1. Clica en el icono de la columna campos
Al abrir más opciones, verás un apartado detallando los datos que recibirás para cada evento, y en cuál formato.
En el caso en que hayas agregado Campos Customizables a tus Campañas, estos también aparecerán en tus Eventos.
5. Configura Notificaciones por URL o Email
1. Escoge el Evento que quieres Configurar.
2. Selecciona el icono en la columna Suscriptores.
Una ventana se abrirá, donde podrás ver informaciones de suscripciones ya creadas, caso la tengas, además del botón añadir para una nueva.
Una vez has hecho clic en el añadir verás la próxima pantalla donde podrás seleccionar entre las opciones.
1. Recibir notificaciones para todas las Campañas o solo una en particular, y
2. A donde quieres enviar los datos (Email o URL)
3. Activar la suscripción cuando ya esté lista
4. Omitir el envío de los eventos cuando sea una aportación offline. Haz clic aquí para saber más sobre aportaciones offline.
5. Omitir el envío de los eventos cuando sea una transacción CRM. Haz clic aquí para saber más sobre transacciones CRM.
6. Enviará eventos de operaciones realizadas en la campaña antes de la creación de la suscripción.
En el caso en que elijas enviar los datos a una URL, un informático deberá configurar la URL en la que deseas que enviemos la información, eligiendo también la API Key para autenticación y el formato deseado.
A parte de configurar esto en Stockcrowd, tu equipo de IT también deberá hacer las configuraciones en tu CRM Software en el que quieres recibir la información por URL.
👉 Recomendamos que siga las instrucciones del apartado Campos > Validación del Evento para configurar y testear el Webhook.
6. Gestiona tus Webhooks
6.1. Subscripciones Registradas
Cuando tengas un Webhook configurado, podrás ver Subscripciones Registradas en Suscriptores.
En esta sección puedes ver y gestionar todos los Webhooks que has configurado para este evento en particular.
Si necesitas hacer cambios a un Webhook definido, selecciona el ícono de la columna Opciones:
6.2. Eventos enviados
Encuentra todos tus Webhooks enviados accediendo al evento desde su nombre o en el icono de ojo.
Ahí podrás consultar los envíos e incluso volver a enviar algún mensaje si te interesa.
Para volver a enviar un mensaje, haz clic en el icono de avión.
6.3. Histórico de Eventos (Logs)
Revisa el histórico de un evento, una vez hayas accedido a los mensajes enviados, podrás ver las opciones disponibles en el icono de engranaje.
Datos - Información enviada en el evento
Http logs - Logs de cuando la información sea envíada a una URL
Errores - Mensajes de error cuando el evento no haya sido enviado. En caso de un fallo en la entrega del evento, el sistema re-intenta el envio cada 24 horas por un total de tres intentos.
