Links cuenta con la posibilidad de agregar un servicio HTTP tipo WebHook para recibir las notificaciones de los clics en tiempo real.

<aside> ⚠️ Esta funcionalidad no está disponible para las URLs que se generen mediante la integración con otros productos, en esos casos se reportará la información directamente a los webhooks de dichos productos.

</aside>

¿Como añadir un Webhook?

Para la generación de links vía API se cuenta con una propiedad incluida en la solicitud de la misma, en la firma del endpoint hay un campo llamado ‘webhook’, este acepta una lista de webhook a las que quiere que Links reporte los eventos de clic de su URL.

<aside> 💡 Links tardará entre 3 a 5 minutos en reportar los eventos de clic a su webhook(s) de dado el clic.

</aside>

A continuación se visualiza un ejemplo de la firma en formato JSON de la generación de URL desde el endpoint Shorter de Links, la propiedad subrayada webHooks de tipo cadena de texto se debe indicar la URL completa del servicio tipo webhook en donde se recibirá los clics respectivos. Si tiene dudas de como realizar la petición revisar el siguiente enlace:

POST Shorter

{
    "idClient": 00001,
    "idCampaign": 1,
    "IdProduct": "masivlinks",
    "customDomain": "<https://links.ma.sv/>",
    "UrlDueDate": "",
    "UrlActiveDate": "2023-07-28 11:24:20",
    "UrlType": 0,
    "idDelivery": "1234567890",
    "webHooks": ["<https://webhookUrlExample.web.hook/>"],
    "UrlRequest": [
        {
            "name": "Test ",
            "url": "<https://www.google.com/>",
            "preview": {
                "Title": "Test",
                "Description": "Test",
                "KeyImage": ""
            }
        }
    ]
}

Ejemplo de notificación al Webhook

La firma del servicio HTTP tipo webhook debe ser la siguiente, se comparte un ejemplo totalmente descriptivo de cada uno de los datos compartidos en el servicio.

{
  "EventType": "UserClick",
  "EventBody": {
    "Metadata": {},
    "Segment": "Q7tAxat",
    "IdClient": "00001",
    "IdCampaign": "20230824141025935",
    "IdProduct": "masivlinks",
    "IdDelivery": "20230824141025935",
    "Recipient": "email@masiv.com",
    "CreationDate": "2023-08-24",
    "ActiveDate": "2023-08-24",
    "UrlDomain": "<https://links.ma.sv>",
    "TargetUrl": "<https://www.google.com/>",
    "ClickAccessDate": "2023-08-24 14:12:01",
    "UserAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36 Edg/116.0.1938.54",
    "BrowserName": "Microsoft Edge",
    "DeviceVendor": "Samsung",
    "DeviceType": "Cellular",
    "OsName": "Android",
    "IpRemote": "::ffff:186.29.181.118",
    "ConnectionType": "Cellular",
    "CountryName": "Colombia",
    "IspName": "Claro",
    "OrganizationName": "Claro"
  }
}