How to Integrate WebEngage with Popin

How to Integrate WebEngage with Popin

This guide walks you through integrating Popin with WebEngage to ensure all user interactions, lead activity, and call events are automatically synced for enhanced marketing and automation workflows.


🔧 Integration Steps

Step 1: Get WebEngage API Credentials

  • Log in to your WebEngage account.

  • Navigate to Integrations > API & SDK.

  • Copy your WebEngage Code and API Key.

Step 2: Log in to Popin Dashboard

Step 3: Navigate to Integration Settings

  • In the dashboard, go to:
    Integrations > WebEngage

Step 4: Enter API Credentials

  • Paste the WebEngage Code and Key copied earlier.

Step 5: Save the Integration

  • Click Save.
    ✅ Your Popin account is now successfully integrated with WebEngage!

Once integrated, Popin will automatically send user events and activities to WebEngage in real-time.


📤 Events Sent from Popin to WebEngage

All events sent to WebEngage contain the following standard properties:

  • userId: <<country_code + user_mobile>>

  • eventTime: <<current timestamp>>

  • eventName: Describes the type of interaction

  • data: (if applicable) Detailed event payload


1. 📍 Popin User Captured

Triggered when a user is captured through Popin.

{
  "userId": "<<country_code + user_mobile>>",
  "eventName": "Popin User Captured",
  "eventTime": "<<current timestamp>>"
}

2. 📞 Popin user call successful

Triggered after a successful call between the user and agent.

{
  "userId": "<<country_code + user_mobile>>",
  "eventName": "Popin user call successful",
  "eventTime": "<<current timestamp>>",
  "data": {
    "duration": "<<integer in seconds>>",
    "url": "<<string>>",
    "agent": {
      "name": "<<string>>",
      "email": "<<string>>"
    },
    "user": {
      "name": "<<string>>",
      "email": "<<string>>",
      "phone_number": "<<string>>",
      "country_code": "<<string>>"
    }
  }
}

3. ❌ Popin user call missed

Triggered when a user misses a scheduled or on-demand call.

{
  "userId": "<<country_code + user_mobile>>",
  "eventName": "Popin user call missed",
  "eventTime": "<<current timestamp>>",
  "data": {
    "url": "<<string>>",
    "user": {
      "name": "<<string>>",
      "email": "<<string>>",
      "phone_number": "<<string>>",
      "country_code": "<<string>>"
    }
  }
}

4. 🚫 Popin user call abandoned

Triggered when the user drops the call before it connects.

{
  "userId": "<<country_code + user_mobile>>",
  "eventName": "Popin user call abandoned",
  "eventTime": "<<current timestamp>>",
  "data": {
    "url": "<<string>>",
    "user": {
      "name": "<<string>>",
      "email": "<<string>>",
      "phone_number": "<<string>>",
      "country_code": "<<string>>"
    }
  }
}

5. 📩 Popin missed call invited

Triggered when an agent invites the user to reschedule or reconnect after a missed call.

{
  "userId": "<<country_code + user_mobile>>",
  "eventName": "Popin missed call invited",
  "eventTime": "<<current timestamp>>",
  "data": {
    "url": "<<string>>",
    "agent": {
      "name": "<<string>>",
      "email": "<<string>>"
    },
    "user": {
      "name": "<<string>>",
      "email": "<<string>>",
      "phone_number": "<<string>>",
      "country_code": "<<string>>"
    }
  }
}

6. 🗓️ Popin scheduled call created

Triggered when a user or agent schedules a future call.

{
  "userId": "<<country_code + user_mobile>>",
  "eventName": "Popin scheduled call created",
  "eventTime": "<<current timestamp>>",
  "data": {
    "url": "<<string>>",
    "scheduled_url": "<<string>>",
    "time": "<<string in format HH:MM AM/PM>>",
    "date": "<<string in format DD-MM-YYYY>>",
    "agent": {
      "name": "<<string>>",
      "email": "<<string>>"
    },
    "user": {
      "name": "<<string>>",
      "email": "<<string>>",
      "phone_number": "<<string>>",
      "country_code": "<<string>>"
    }
  }
}

7. ⏰ Popin scheduled call pre notified

Sent shortly before the scheduled call as a reminder.

{
  "userId": "<<country_code + user_mobile>>",
  "eventName": "Popin scheduled call pre notified",
  "eventTime": "<<current timestamp>>",
  "data": {
    "url": "<<string>>",
    "scheduled_url": "<<string>>",
    "time": "<<string in format HH:MM AM/PM>>",
    "date": "<<string in format DD-MM-YYYY>>",
    "agent": {
      "name": "<<string>>",
      "email": "<<string>>"
    },
    "user": {
      "name": "<<string>>",
      "email": "<<string>>",
      "phone_number": "<<string>>",
      "country_code": "<<string>>"
    }
  }
}

8. 🔔 Popin scheduled call notified

Triggered at the time of the scheduled call to notify both parties.

{
  "userId": "<<country_code + user_mobile>>",
  "eventName": "Popin scheduled call notified",
  "eventTime": "<<current timestamp>>",
  "data": {
    "url": "<<string>>",
    "scheduled_url": "<<string>>",
    "time": "<<string in format HH:MM AM/PM>>",
    "date": "<<string in format DD-MM-YYYY>>",
    "agent": {
      "name": "<<string>>",
      "email": "<<string>>"
    },
    "user": {
      "name": "<<string>>",
      "email": "<<string>>",
      "phone_number": "<<string>>",
      "country_code": "<<string>>"
    }
  }
}

✅ Summary

By integrating Popin with WebEngage, you unlock automated user journey tracking and engagement triggers for:

  • Call interactions (successful, missed, abandoned)

  • Scheduled call management

  • Agent-user coordination

  • Behavioural insights for personalization and retargeting

    • Related Articles

    • How to integrate your custom CRM on Popin?

      Guide for API Integration with Popin Welcome to the integration guide for the Popin! To enable seamless communication between your e-commerce website and our system, you need to provide two APIs: Lead Submission API - This API will allow us to pass ...
    • Popin - Freshsales Integration Guide

      Introduction Integrating Popin with Freshsales allows you to sync leads and activities seamlessly between the two platforms. Follow this guide to set up the integration quickly. Prerequisites You must have an active Popin account. You must have an ...
    • Popin Zapier Integration Guide

      Popin Zapier App Integration Overview The Popin Zapier App enables you to integrate Popin with thousands of other applications through Zapier. This guide provides instructions on how to connect Popin to Zapier, configure triggers, and use API ...
    • Popin 3P Events Documentation

      Popin provides JavaScript events through window.popinEvent to help track user actions, permissions, and call activities on the widget. Integration Place the following snippet below the Popin integration script: window.popinEvent = (event, data) => { ...
    • Popin Export Report API Documentation

      The Popin Export Report API allows you to export and download reports related to customer calls or scheduled video calls for a specific date. 🔗 API Endpoint POST https://dashboard.popin.to/api/v1/export 🔐 Authentication You need an API key to ...