Guía Webhooks
El servicio de WebHooks permite mantener el estado de los contactos de sus listas sincronizado con su CRM, evitando la necesidad de invocar a la API constantemente en busca de novedades de remoción y/o rebote de contactos.
Un WebHook es un simple callback definido por el usuario en la forma de un POST HTTP en formato JSON, el cual es invocado cuando ocurre una novedad en relación a su lista de contactos. Por ejemplo, cuando alguien se desuscribe, usted podría querer que dicha actualización esté disponible en su sistema de forma inmediata, o con algunas horas de demora. Esto es factible a partir de la definición de una URL a la cual la información debe ser enviada al momento de la ocurrencia del evento solicitado.
Utilizando el ejemplo de una desuscripción, a continuación se detalla la información que se puede obtener en el cuerpo de la petición.
El formato del cuerpo enviado se mantiene uniforme para todos los tipos de eventos existentes, modificándose simplemente el contenido.
A fin de minimizar la cantidad de HTTP POST que se realizan hacia su URL definida, se puede configurar para que diariamente enviemos el resumen de actualizaciones del evento solicitado (remociones o rebotes). De esta forma, en el cuerpo de la petición se detallará una lista de contactos con sus cambios.
Actualmente existen dos tipos de eventos que pueden ser configurados a través del servicio de WebHooks:
• Desuscripción
• Rebotes
A continuación se detallan los campos del formato del cuerpo de la petición.
Action: Tipo de Evento (Unsubscribe/Bounce)
Reason: Motivo de la desuscripción o rebote.
Date: Fecha del evento.
Email: Contacto actualizado.
Status: Estado actual del contacto en el sistema (U: Desuscripto, R: Rebotado)
A continuación se pueden visualizar ejemplos del cuerpo de la petición para cada una de las acciones.
Simplemente debes desarrollar el servicio que procese los datos que Icomm envía con el formato detallado, configurar el mismo en un servidor de acceso público, y luego enviar a tu ejecutivo de cuentas la URL pública hacia donde debemos enviarte los datos. Además, debes indicar la frecuencia de envío (Diaria o por cada evento).
¿Qué es un WebHook?
Un WebHook es un simple callback definido por el usuario en la forma de un POST HTTP en formato JSON, el cual es invocado cuando ocurre una novedad en relación a su lista de contactos. Por ejemplo, cuando alguien se desuscribe, usted podría querer que dicha actualización esté disponible en su sistema de forma inmediata, o con algunas horas de demora. Esto es factible a partir de la definición de una URL a la cual la información debe ser enviada al momento de la ocurrencia del evento solicitado.
Utilizando el ejemplo de una desuscripción, a continuación se detalla la información que se puede obtener en el cuerpo de la petición.
{"Actions":[
{"Action":"Unsubscribe"
,"Reason":"Unsubscribe Request"
,"Date":"20140116 17:41:47"
,"Email":email@domain.com
,"Status":"U"}
]
}El formato del cuerpo enviado se mantiene uniforme para todos los tipos de eventos existentes, modificándose simplemente el contenido.
¿ Eventos Batch ?
A fin de minimizar la cantidad de HTTP POST que se realizan hacia su URL definida, se puede configurar para que diariamente enviemos el resumen de actualizaciones del evento solicitado (remociones o rebotes). De esta forma, en el cuerpo de la petición se detallará una lista de contactos con sus cambios.
{"Actions":[
{"Action":"Unsubscribe"
,"Reason":"Unsubscribe Request"
,"Date":"20140116 17:41:47"
,"Email":email@domain.com
,"Status":"U"},
{"Action":"Bounce"
,"Reason":"Inexistant"
,"Date":"20140116 17:41:47"
,"Email":email2@domain.com
,"Status":"R"}
]
}WebHooks Disponibles
Actualmente existen dos tipos de eventos que pueden ser configurados a través del servicio de WebHooks:
• Desuscripción
• Rebotes
A continuación se detallan los campos del formato del cuerpo de la petición.
Actions: Lista de eventos a procesar
Action: Tipo de Evento (Unsubscribe/Bounce)
Reason: Motivo de la desuscripción o rebote.
Date: Fecha del evento.
Email: Contacto actualizado.
Status: Estado actual del contacto en el sistema (U: Desuscripto, R: Rebotado)
A continuación se pueden visualizar ejemplos del cuerpo de la petición para cada una de las acciones.
Desuscripción
{"Actions":[
{"Action":"Unsubscribe"
,"Reason":"Unsubscribe Request"
,"Date":"20140116 17:41:47"
,"Email":email@domain.com
,"Status":"U"}
]
}Rebotes
{"Actions":[
{"Action":"Bounce"
,"Reason":"Inexistant"
,"Date":"20140116 17:41:47"
,"Email":email2@domain.com
,"Status":"R"}
]
}¿Qué debo hacer para dar de alta el Webhook en Icomm?
Simplemente debes desarrollar el servicio que procese los datos que Icomm envía con el formato detallado, configurar el mismo en un servidor de acceso público, y luego enviar a tu ejecutivo de cuentas la URL pública hacia donde debemos enviarte los datos. Además, debes indicar la frecuencia de envío (Diaria o por cada evento).
Actualizado el: 04/04/2024
¡Gracias!