Published — v. 6
Crea un nuevo Webhook
Configurar un webhook
Para crear un nuevo webhook, ve a la página Configuración> Gestión consola > Avanzados > Webhooks y haz click en Añadir nuevo webhook.
Los webhook, como hemos comentado en la introducción a los webhooks, son fácilmente personalizables y por tanto, al crear uno nuevo, se pueden configurar varios aspectos:
- Nombre: introduce un nombre comprensible sobre el uso de dicho webhook (se utilizará sólo internamente).
- URL: se trata del Callback URL, el URL de la página que recibe la "llamada" cuando se envía un mensaje automático desde el webhook.
- Tipo: en este momento hay disponibles 4 eventos que desencadenan la ejecución de un webhook:
- Suscripción: un destinatario se ha inscrito en la Lista.
- Baja: un destinatario se ha dado de baja en la Lista.
- Cambio de perfil: los datos del perfil de un destinatario han sido modificados, incluídos datos como por ejemplo, el Grupo al que pertenece.
- Eliminación: un destinatario ha sido eliminado de la Lista.
- Fuente: un evento puede tener lugar en 3 ambientes (fuentes) diferentes:
- API: el evento se ha dado gracias a una llamada API (por ejemplo, cuando un destinatario se registra mediante un módulo que realiza una llamada API a la consola para modificar la base de datos).
- Consola: el evento se ha llevado a cabo por alguien directamente desde la consola (por ejemplo, cuando un destinatario ha sido añadido manualmente).
- Recipient (Destinatario): el evento ha registrado una acción hecha por el destinatario (por ejemplo, cuando el destinatario se ha dado de baja).
- Método: el método utilizado para realizar técnicamente la llamada, que puede ser en POST o en GET.
- Activación: si el webhook está activo o no.
- Codificación: si el webhook está encriptado o no (si lo está, es necesario especificar la contraseña)
- MailUp utiliza RC4 encryption y la contraseña entregada para encriptar.
- Los datos se convierten en código Base64
- La página de recepción de la llamada - conociendo la contraseña - puede fácilmente extraer los datos encriptados.
- Parámetros: los parámetros enviados en la llamada, ve abajo para ver los detalles.
Parámetros
Los parámetros que pueden incluírse en las llamadas son:
- [EventDate]: la fecha en que se ha verificado el evento en formato ISO 8601 (por ejemplo: 2012-09-12T11:18:37.664+02)
- [IdConsole]: el ID de la cuenta
- [IdList]: el ID de la Lista
- [IdNL]: el ID del mensaje
- [EventType]: el tipo de evento
- [EventSource]: la fuente del evento
- [Reason]: la razón por la cual el destinatario se ha dado de baja. Se aplica sólo a las bajas e incluye el código que define los varios tipos de Bounce.
- [Email]: la dirección email del destinatario
- [Prefix]: el prefijo internacional del número de teléfono del destinatario
- [Number]: el número de teléfono del destinatario
- [Groups]: una lista, separada por comillas, de los Grupos a los que pertenece el destinatario de una Lista [IdList]
- [Channel]: canal de comunicación señalado por códigos: 0 (Email), 1 (Sms), 2 (Fax), 5 (Social), -1 (Unknown, o sea, un evento no asociado a un canal).
- Todos los Campos anagráficos en el formato [Nome] ... [indirizzo]
Límites de los webhooks
En este momento, no se realizarán llamadas webhook en el caso de:
- importes masivos
- uso de webservice
Los webhook son apicables a una Lista específica y de momento no es posible crear un webhook que se aplique a todas las Listas. Con pocos pasos, en el momento de la creación de una Lista, se puede copiar un webhook de otras listas ya existentes.
Argumentos relacionados