Documentación
Webhooks

Qué es un webhook

Un webhook es una herramienta que permite a un sistema o aplicación enviar notificaciones sobre un evento específico a otro sistema o aplicación en tiempo real.

De esta manera, al configurar los webhooks de EnvíaloSimple podrás conectarlos a una URL pública (perteneciente al sistema o aplicación de destino) a la cuál se enviarán notificaciones cuando se produzca un evento específico en la herramienta. Por ejemplo: el envío de una campaña, la suscripción de un contacto, entre otros.

Configuración en EnvíaloSimple

Configurar un webhook es muy sencillo y puedes hacerlo siguiendo estos pasos:

1. 1) Una vez que inicias sesión en EnvíaloSimple, dirígete a Configuración.
2. 2) Luego, ingresa a la sección de Webhooks desde el menú lateral.
3. 3) Allí, tendrás que copiar la URL perteneciente al sistema o aplicación a la cual se va a integrar. (Debes agregar el formato http(s) al inicio)
4. 4) Seguidamente, verás la lista completa de eventos disponibles, donde podrás seleccionar aquellos de los cuáles deseas recibir notificaciones.
5. 5) Al final, recuerda guardar los cambios.

Detalle de los eventos

Apertura de campaña

Esta notificación se envía cuando un contacto abre una campaña. Si un mismo contacto abre varias veces la misma campaña solo se notificará la primera vez.

Datos que devuelve:

Nombre	Descripción
id	Id único del evento.
event	Tipo de evento: “campaign_read”.
email	Email del contacto que abrió la campaña.
ts_event	Fecha/hora que se realizó la apertura
campaign_id	ID de la campaña que se abrió.
campaign_name	Nombre de la campaña que se abrió.
ts_sent	Fecha/hora envío de la campaña que se abrió.

Ejemplo:

{
   id: "39f3abfc43b23e",
   event: "campaign_read",
   email: "contacto@dominio.com",
   ts_event: 1631199366,
   campaign_id: "383",
   campaign_name: "Campaña de Prueba",
   ts_sent: 1631198557,
}
                    

Campaña enviada

Se envía una notificación tras el envío exitoso de una campaña.

Datos que devuelve:

Nombre	Descripción
id	Id único del evento.
event	Tipo de evento: “campaign_sent”.
ts_event	Fecha/hora que se envió la campaña.
campaign_id	D de la campaña que se envió.
campaign_name	Nombre de la campaña que se envió.

Ejemplo:

{
   id: "61269d5887e2f",
   event: "campaign_sent",
   ts_event: 1629920600,
   campaign_id: "200",
   campaign_name: "Nombre de la Campaña",
}
                    

Clic en una campaña

Se envía una notificación cuando un contacto hace clic en algún enlace de la campaña.

Datos que devuelve:

Nombre	Descripción
id	Id único del evento.
event	Tipo de evento: “campaign_click”.
email	Email del contacto que hizo clic en la campaña.
ts_event	Fecha/hora que se realizó clic.
campaign_id	ID de la campaña en la que se hizo clic.
campaign_name	Nombre de la campaña en la que se hizo clic.
ts_sent	Fecha/hora envío de la campaña en la que se hizo clic.
campaign_url	Enlace de la campaña en la que se hizo clic.

Ejemplo:

{
   id: "39f3abff06dbcc",
   event: "campaign_click",
   email: "contacto@dominio.com",
   ts_event: 1631199371,
   campaign_id: "383",
   campaign_name: "Campaña de Prueba",
   ts_sent: 1631198557,
   campaign_url: "http://www.google.com?mkt_hm=1&utm_source=email_marketing&utm_admin=123&utm_medium=email&utm_campaign=Prueba_Webhooks",
}
                    

Suscripción contacto

Se envía una notificación cuando:

• El contacto se suscribe a una o varias listas desde los formularios (la notificación se envía cuando se recibe la confirmación del correo).
• El administrador suscribe al contacto entrando a la lista y agregándolo.
• El administrador crea un contacto individual asignándolo a una o varias listas.

Datos que devuelve:

Nombre	Descripción
id	Id único del evento.
event	Tipo de evento: “member_subscribe”.
ts_event	Fecha/hora de la suscripción.
email	Email del contacto que se suscribió.
list_ids	IDs de las listas a las que se subscribió.

Ejemplo:

{
   id: "612cfec2819fb",
   event: "member_subscribe",
   ts_event: 1630338754,
   email: "contacto@dominio.com",
   list_ids: [
      "13",
   ],
}
                    

Desuscripción contacto

Se envía una notificación cuando:

• El contacto se desuscribe de una o todas las listas desde el enlace proporcionado en el pie de las campañas.
• El administrador desuscribe al contacto entrando a la lista y eliminándolo.

Datos que devuelve:

Nombre	Descripción
id	Id único del evento.
event	Tipo de evento: “member_unsubscribe”.
ts_event	Fecha/hora de la suscripción.
reason	Razón de la desuscripción. Valores posibles: delete ⇒ Para la desuscripción realizada desde la lista alreadyUnsubscribed ⇒ Ya me desuscribí irrelevant ⇒ Contenidos irrelevantes neverSignUp ⇒ Nunca me suscribí other ⇒ Otros spam ⇒ Lo considero SPAM tooOften ⇒ Demasiada frecuencia
email	Email del contacto que se desuscribió.
list_ids	IDs de las listas de las que se desuscribió.
campaign_id	ID de la campaña desde la que de desuscribió. Sólo para la desuscripción desde el enlace de la campaña.
campaign_name	Nombre de la campaña desde la que se desuscribió. Sólo para la desuscripción desde el enlace de la campaña.
ts_sent	Fecha/hora envío de campaña desde la que se desuscribió. Sólo para la desuscripción desde el enlace de la campaña.

Ejemplo:

{
   id: "612d0604472c8",
   event: "member_unsubscribe",
   ts_event: 1630340612,
   reason: "irrelevant",
   email: "contacto@dominio.com",
   list_ids: [
      "5",
   ],
   campaign_id: "201",
   campaign_name: "Campaña de Prueba",
   ts_sent: 1630340179,
}