Popin Webhook Integration Guide

Popin Webhook Integration Guide

Popin’s webhook functionality allows you to receive real-time notifications about events happening in your Popin widget.

This guide explains how to set up webhooks and describes the event payloads you can expect to receive.

📌 Setting Up Webhooks

1. Log in to your Popin Dashboard.

2. Navigate to: Settings > Integrations > Webhook

3. Click Setup.

4. Enter your Webhook URL where Popin should send event notifications.

5. Use an API key for authentication, or . (dot) if an API key is not available.

6. If configured, the API key will be included in the request header as:

X-API-KEY: your_api_key

1. Save your settings.

✅ Once configured, Popin will POST event data to your specified URL whenever supported events occur.

📦 Supported Events and Payloads

1. User Captured

Event name: popin_user_captured Description: Triggered when a user's details are captured.

{
  "event": "popin_user_captured",
  "user_id": string,
  "email": string,
  "country_code": string,
  "phone_number": string,
  "full_phone_number": string,
  "properties": {
    "customer_name": string,
    "customer_email": string,
    "customer_country_code": string,
    "customer_phone_number": string,
    "url": string
  },
  "meta": object,
  "timestamp": string
}

2. Scheduled Call Created

Event name: popin_scheduled_created Description: Triggered when a scheduled call is created.

{
  "event": "popin_scheduled_created",
  "user_id": string,
  "email": string,
  "country_code": string,
  "phone_number": string,
  "full_phone_number": string,
  "properties": {
    "customer_name": string,
    "scheduled_time": string,
    "scheduled_date": string,
    "scheduled_time_local": string,
    "scheduled_date_local": string,
    "url": string,
    "agent_name": string,
    "agent_email": string
  },
  "meta": object,
  "timestamp": string
}

3. Scheduled Call Notified

Event name: popin_scheduled_notification Description: Triggered when a scheduled call notification is sent.

{
  "event": "popin_scheduled_notification",
  "user_id": string,
  "email": string,
  "country_code": string,
  "phone_number": string,
  "full_phone_number": string,
  "properties": {
    "customer_name": string,
    "scheduled_time": string,
    "scheduled_date": string,
    "scheduled_time_local": string,
    "scheduled_date_local": string,
    "url": string,
    "agent_name": string,
    "agent_email": string
  },
  "meta": object,
  "timestamp": string
}

4. Call Abandoned

Event name: popin_call_abandoned Description: Triggered when a call is abandoned.

{
  "event": "popin_call_abandoned",
  "user_id": string,
  "email": string,
  "country_code": string,
  "phone_number": string,
  "full_phone_number": string,
  "properties": {
    "customer_name": string,
    "url": string
  },
  "meta": object,
  "timestamp": string
}

5. Call Missed

Event name: popin_call_missed Description: Triggered when a call is missed.

{
  "event": "popin_call_missed",
  "user_id": string,
  "email": string,
  "country_code": string,
  "phone_number": string,
  "full_phone_number": string,
  "properties": {
    "customer_name": string,
    "url": string
  },
  "meta": object,
  "timestamp": string
}

6. Call Successful

Event name: popin_call_successful Description: Triggered when a call is successfully completed.

{
  "event": "popin_call_successful",
  "user_id": string,
  "email": string,
  "country_code": string,
  "phone_number": string,
  "full_phone_number": string,
  "properties": {
    "customer_name": string,
    "call_duration": number,
    "url": string,
    "agent_name": string,
    "agent_email": string
  },
  "meta": object,
  "timestamp": string
}

7. Call Rated

Event name: popin_call_rated Description: Triggered when a call is rated.

{
  "event": "popin_call_rated",
  "user_id": string,
  "email": string,
  "country_code": string,
  "phone_number": string,
  "full_phone_number": string,
  "properties": {
    "customer_name": string,
    "rating": number,
    "comments": string,
    "url": string,
    "agent_name": string,
    "agent_email": string
  },
  "meta": object,
  "timestamp": string
}

8. Call Remark Added

Event name: popin_call_remark_added Description: Triggered when a remark is added to a call.

{
  "event": "popin_call_remark_added",
  "user_id": string,
  "email": string,
  "country_code": string,
  "phone_number": string,
  "full_phone_number": string,
  "properties": {
    "customer_name": string,
    "call_duration": number,
    "url": string,
    "remark": string,
    "agent_name": string,
    "agent_email": string
  },
  "meta": object,
  "timestamp": string
}

9. Missed Call Invited

Event name: popin_missed_notification Description: Triggered when a missed call invitation is sent.

{
  "event": "popin_missed_notification",
  "user_id": string,
  "email": string,
  "country_code": string,
  "phone_number": string,
  "full_phone_number": string,
  "properties": {
    "customer_name": string,
    "url": string,
    "agent_name": string,
    "agent_email": string
  },
  "meta": object,
  "timestamp": string
}

10. Scheduled Call Pre-Notified

Event name: popin_prescheduled_notification Description: Triggered when a pre-notification is sent for a scheduled call.

{
  "event": "popin_prescheduled_notification",
  "user_id": string,
  "email": string,
  "country_code": string,
  "phone_number": string,
  "full_phone_number": string,
  "properties": {
    "customer_name": string,
    "scheduled_time": string,
    "scheduled_date": string,
    "scheduled_time_local": string,
    "scheduled_date_local": string,
    "url": string,
    "agent_name": string,
    "agent_email": string
  },
  "meta": object,
  "timestamp": string
}

11. Call Not Ringing

Event name: popin_call_not_ringing Description: Triggered when a call is not ringing.

{
  "event": "popin_call_not_ringing",
  "user_id": string,
  "email": string,
  "country_code": string,
  "phone_number": string,
  "full_phone_number": string,
  "properties": {
    "agent_name": string,
    "agent_email": string,
    "customer_name": string,
    "customer_email": string,
    "customer_country_code": string,
    "customer_phone_number": string
  },
  "meta": object,
  "timestamp": string
}

12. Call Guest Connected

{
  "event": "popin_call_guest_connected",
  "guest_type": string,
  "guest_id": string,
  "properties": {
    "url": string,
    "agent_name": string,
    "agent_email": string,
    "customer_name": string,
    "customer_email": string,
    "customer_country_code": string,
    "customer_phone_number": string,
    "full_phone_number": string
  },
  "meta": object,
  "timestamp": string
}

13. User OTP Requested

{
  "event": "popin_user_otp",
  "user_id": string,
  "country_code": string,
  "phone_number": string,
  "full_phone_number": string,
  "properties": {
    "otp": number,
    "customer_name": string,
    "customer_country_code": string,
    "customer_phone_number": string
  },
  "meta": object,
  "timestamp": string
}

• ✅ Verify your webhook URL in the Popin dashboard.

• 🪵 Check your server logs for incoming requests.

• 🌍 Ensure your endpoint is publicly accessible.

• 🔐 Review firewall/security settings that may block requests.