Conscent.ai Developer Documentation
  • Version 2.0
    • Using Conscent.ai
    • Web SDK
    • Login
    • Logout
    • User Details Drawer
    • Google One Tap
    • Mobile SDK
      • iOS(Swift)
        • In-App Purchases with Conscent
      • Android SDK
      • React Native SDK
      • Google In-App Purchases with Conscent
      • Apple In-App Purchases with Conscent
    • Facebook SSO Integration Guide
    • Landing Page API v 2.0
    • AMP Integration
    • Integrating APIs(v2)
      • Purchase Details
      • User Registered Or Not
      • User Registrations
      • Subscription Plans Details
      • Get User Details
      • Add Subscription If User Registered
      • Update UserDetails
      • Update SubscriptionDetails
      • Get All Transaction Details
    • IAM System API Documentation
  • Version 1.0
    • Getting Started
    • On Board
    • Using Conscent.ai
    • Authentication
    • Web SDK
    • Login
    • Logout
    • Amp Documentation
    • Mobile SDK
      • Android
      • Flutter
      • iOS(Swift)
      • React Native SDK
    • Auto Login
    • Creating External Purchases
    • Landing Page API
  • Login Screen Customization
  • Integrating Client Payment Gateway
  • Integrating with APIs
    • User Details and Subscriptions Information
    • Purchased Subscriptions
    • User and Purchase Details
    • Client Purchases
    • Client Micropayments
    • Client Passes
    • Cancel Active Subscriptions
    • Delete User
  • Events API Docs
    • Different Types of Events
    • SSO Login Flow
  • Discount Coupon
    • Dynamic Coupon API Generation:
  • New Webhooks
    • Meter Banner Webhook
    • Paywall Webhook
    • SignUp Webhook
    • Refund Webhook
    • Purchase Webhook
    • Subscription Landing Page Webhook
    • Popup Webhook
    • User Update Webhook
    • Payment Gateway Webhook
    • Review Page Webhook
    • Transaction Webhook
    • Login Webhook
    • Cancel Subscription Webhook
  • Old Webhooks
    • Sign Up Webhook
    • Login Webhook
    • Subscription Payment Webhook
    • Subscription Cancelled Webhook
    • Pass Payment Webhook
    • Subscription Bundle Payment Webhook
    • Review Subscription Webhook
    • Micro Payment Webhook
    • How to validate Webhooks?
  • Registering The Content
    • Create Content
    • Edit Content
    • View Content
  • Country Code List
  • Supported Currencies and Payment Gateways
    • Stripe Supported Country with Currency
    • Razorpay Supported Country with Currency
    • Paypal Supported Country with Currency
  • Errors
  • Loyalty System
    • Web SDK
    • iOS SDK
    • Android SDK
    • Flutter SDK
    • API from server
Powered by GitBook
On this page
  1. New Webhooks

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
}
PreviousSubscription Landing Page WebhookNextUser Update Webhook

Last updated 1 year ago