Popup Webhook

A Popup Webhook is used to trigger actions or notifications based on user interactions with pop-up elements on a website or web application.

Popup.click: This event is triggered when users click on the popup.

{
  "entity": "event",
  "user_id": "65e026f7d03692125f1f36fa",
  "event": "popup.click",
  "contains": [
    "action",
    "user",
    "popup"
  ],
  "payload": {
    "action": {
      "clickAction": "POPUP_REDIRECT",
      "pageUrl": "https://csc-mock.netlify.app/65015ff10070846629fb981e/Client-Story-Id-7"
    },
    "user": {
      "phoneNumber": "8943489898",
      "userId": "65e026f7d03692125f1f36fa",
      "country": "IN",
      "address": {
        "apartment": "",
        "area": "",
        "pincode": "",
        "landmark": "",
        "city": "",
        "state": "",
        "country": ""
      },
      "name": "",
      "city": "new delhi (okhla phase i)",
      "location": {
        "latitude": 28.5223,
        "longitude": 77.2849,
        "postcode": "110001"
      },
      "username": "8943489898"
    },
    "popup": {
      "_id": "65a66ec068557b0579a275b5",
      "deletedAt": null,
      "clientId": "65015ff10070846629fb981e",
      "title": "Pop Ferrari",
      "link": "https://conscent.ai/",
      "version": "v2",
      "type": "DESKTOP",
      "imageFileName": "CaaRRar.jpg",
      "imageFileSizeBytes": 291427,
      "imageUrl": "https://bkt-conscent-public-stage.storage.googleapis.com/Black Panther/popups/65a66ec068557b0579a275b5-desktop-f84b9e",
      "createdAt": "2024-01-16T11:55:45.001Z",
      "updatedAt": "2024-01-16T11:55:45.001Z",
      "__v": 0
    }
  },
  "client_info": {
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/121.0.0.0 Safari/537.36",
    "country": "India",
    "countryCode": "IN",
    "deviceType": "desktop",
    "deviceModel": "Macintosh"
  },
  "created_at": 1709188867
}

Popup.close: This event is triggered when users click the 'X' or 'Close' button on the Pop-Up.

{
  "entity": "event",
  "user_id": "65e026f7d03692125f1f36fa",
  "event": "popup.close",
  "contains": [
    "action",
    "popup",
    "user"
  ],
  "payload": {
    "action": {
      "clickAction": "POPUP_CLOSE",
      "pageUrl": "https://csc-mock.netlify.app/65015ff10070846629fb981e/Client-Story-Id-7"
    },
    "popup": {
      "_id": "65a66ec068557b0579a275b5",
      "deletedAt": null,
      "clientId": "65015ff10070846629fb981e",
      "title": "Pop Ferrari",
      "link": "https://conscent.ai/",
      "version": "v2",
      "type": "DESKTOP",
      "imageFileName": "CaaRRar.jpg",
      "imageFileSizeBytes": 291427,
      "imageUrl": "https://bkt-conscent-public-stage.storage.googleapis.com/Black Panther/popups/65a66ec068557b0579a275b5-desktop-f84b9e",
      "createdAt": "2024-01-16T11:55:45.001Z",
      "updatedAt": "2024-01-16T11:55:45.001Z",
      "__v": 0
    },
    "user": {
      "phoneNumber": "8943489898",
      "userId": "65e026f7d03692125f1f36fa",
      "country": "IN",
      "address": {
        "apartment": "",
        "area": "",
        "pincode": "",
        "landmark": "",
        "city": "",
        "state": "",
        "country": ""
      },
      "name": "",
      "city": "new delhi (okhla phase i)",
      "location": {
        "latitude": 28.5223,
        "longitude": 77.2849,
        "postcode": "110001"
      },
      "username": "8943489898"
    }
  },
  "client_info": {
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/121.0.0.0 Safari/537.36",
    "country": "India",
    "countryCode": "IN",
    "deviceType": "desktop",
    "deviceModel": "Macintosh"
  },
  "created_at": 1709188871
}

Popup.view: This event is triggered when users view the popup.

{
  "entity": "event",
  "user_id": "65e026f7d03692125f1f36fa",
  "event": "popup.view",
  "contains": [
    "action",
    "popup",
    "user"
  ],
  "payload": {
    "action": {
      "pageUrl": "https://csc-mock.netlify.app/65015ff10070846629fb981e/Client-Story-Id-7"
    },
    "popup": {
      "_id": "65a66ec068557b0579a275b5",
      "deletedAt": null,
      "clientId": "65015ff10070846629fb981e",
      "title": "Pop Ferrari",
      "link": "https://conscent.ai/",
      "version": "v2",
      "type": "DESKTOP",
      "imageFileName": "CaaRRar.jpg",
      "imageFileSizeBytes": 291427,
      "imageUrl": "https://bkt-conscent-public-stage.storage.googleapis.com/Black Panther/popups/65a66ec068557b0579a275b5-desktop-f84b9e",
      "createdAt": "2024-01-16T11:55:45.001Z",
      "updatedAt": "2024-01-16T11:55:45.001Z",
      "__v": 0
    },
    "user": {
      "phoneNumber": "8943489898",
      "userId": "65e026f7d03692125f1f36fa",
      "country": "IN",
      "address": {
        "apartment": "",
        "area": "",
        "pincode": "",
        "landmark": "",
        "city": "",
        "state": "",
        "country": ""
      },
      "name": "",
      "city": "new delhi (okhla phase i)",
      "location": {
        "latitude": 28.5223,
        "longitude": 77.2849,
        "postcode": "110001"
      },
      "username": "8943489898"
    }
  },
  "client_info": {
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/121.0.0.0 Safari/537.36",
    "country": "India",
    "countryCode": "IN",
    "deviceType": "desktop",
    "deviceModel": "Macintosh"
  },
  "created_at": 1709188865
}

Last updated