SaleAssist for Developers
HomeDashboardAPI DocsBook A Demo
  • 👋Welcome
  • Introduction
  • Onboarding Steps
  • Admin Account Creation
  • Getting Started
  • Features Overview
    • Live Video Calling
      • Outbound Calls
        • Schedule Video Meets
        • Instant Video Meets
      • Inbound Calls
        • How to use ?
        • Integration
        • Desktop Call Management
    • Live Stream Selling
      • How to go Live?
      • Get RTMP and Stream Key from social channels.
    • Shoppable Videos Tiles
      • How to use?
      • Integration
    • Strike
      • AI Videos
    • Co-Browsing
  • Integration Guide
    • Mobile SDK integration
      • Cobrowse - Flutter SDK
      • React Native SDK
      • IOS SDK
      • Android SDK
      • How to delete my account?
      • Cobrowse - Android SDK
      • Cobrowse - IOS SDK
      • Identify your devices for Cobrowse
      • Use 6-digit codes
      • Redact sensitive data
      • Start and Stop Cobrowsing
      • Listening for events
    • User Experience
    • Agent Mapping
    • Nudges
    • Agent Feedback
    • AI Chat (Add Context)
    • API Integration
    • Webhook Integration
    • FAQ & Troubleshooting
    • Lead Management
    • Task Management
    • SaleAssist Whatsapp Feature
    • Sales/Conversion Tracking - Widget
    • Sales/Conversion Tracking - Video Tiles
    • Integrate meetings lite dashboard
  • Assets Managment
    • Media
    • Products
    • Orders
  • Organization Settings
    • Profile
    • Organization
    • Users & Roles
    • SMTP Integration
    • Custom Domain
    • Notification Manager
  • Addons
    • Transcription & Summarization
    • Video QR Codes
    • Video Emails
    • Live Chat
    • Outbound Phone Calling
    • Book In-store appointment
    • Schedule Call
    • Shoppable Video Links
      • How to use?
      • Integration
    • Video FAQs
      • How to use?
      • Integration
    • WhatsApp Onboarding steps
  • Analytics
    • Widget Insights
    • Video tiles insights
    • Reporting
    • SaleAssist Mobile Application
    • How to manage calls on Mobile Application
    • Admin Controls
  • Troubleshooting
    • Troubleshoot Video Call Permissions
  • Release Logs
    • v24.11.24
    • v24.11.30
    • v24.12.10
    • v25.01.10
    • v25.01.18
    • v25.01.29
    • v25.02.05
    • v25.02.05
Powered by GitBook
On this page

Was this helpful?

  1. Integration Guide

Webhook Integration

SaleAssist Webhook integration

1. Sample Payload for event (widget new conversation) :-

Below is the sample payload for one of our webhook event and it has lots of data in it but to get only the required lead data you just need to follow below sequence to map fields at your end to capture. payload.people_detail.name payload.people_detail.mobile_number payload.people_detail.email and so on…

OVERALL MASTER PAYLOAD :- (highlighted the LEAD data in it)

{
    "event_type": "widget_new_conversation",
    "payload": {
      "message_content": "6380dc9b-3af9-4362-b7b1-32d47c13df4f",
      "message_type": "schedule_meeting",
      "message_from": "9d438aaa-1eaa-496a-a8b3-b4f98367bb0d",
      "meta": [
        {
          "moderators": [
            "chetan@saleassist.ai",
            "8373916383"
          ],
          "participants": [
            "+918765875687"
          ],
          "date": "7/11/2024",
          "time": "04:30 PM",
          "timezone": "Asia/Calcutta",
          "duration": 30,
          "duration_mode": "min",
          "watermark": "https://static.saleassist.ai/icons/saleassist-icon-black.png",
          "rrule": "",
          "registration_enabled": false,
          "products_enabled": false,
          "registration_form": "[{\"type\":\"paragraph\",\"subtype\":\"p\",\"label\":\"Please fill in your details to register\",\"access\":false},{\"type\":\"text\",\"required\":true,\"label\":\"Name\",\"placeholder\":\"Enter your name\",\"className\":\"form-control\",\"name\":\"name\",\"access\":false,\"subtype\":\"text\"},{\"type\":\"text\",\"required\":true,\"label\":\"Email\",\"placeholder\":\"Enter your email\",\"className\":\"form-control\",\"name\":\"email\",\"access\":false,\"subtype\":\"text\"},{\"type\":\"text\",\"required\":false,\"label\":\"Mobile number\",\"placeholder\":\"Enter your mobile number\",\"className\":\"form-control\",\"name\":\"mobile_number\",\"access\":false,\"subtype\":\"text\"}]",
          "capture_registration_otp_params": false,
          "registration_otp_params": "email",
          "unique_field_name": "email",
          "is_recurring": false,
          "auto_record": true,
          "end_recurring": 0,
          "room_name": "",
          "meeting_name": "Meeting with +918765875687",
          "description": "",
          "meeting_password": "",
          "meeting_type": "live_call",
          "can_co_browse": true,
          "channels": [],
          "widgets": [],
          "products": [],
          "products_listing_mode": "buy",
          "is_moderated_chat": false,
          "moderation_mode": "auto_censored",
          "moderated_keywords": [],
          "pinned_messages": [],
          "thumbnail": "",
          "id": "6380dc9b-3af9-4362-b7b1-32d47c13df4f",
          "created_by_user_id": "a184afcd-6d05-4052-a156-4c057ce723e8",
          "recording_url": "",
          "events": [],
          "tokens": {},
          "recurring_batch_id": "",
          "start_time": 0,
          "end_time": 0,
          "run_time": 0,
          "recording_time": 0,
          "streaming_time": 0,
          "cumulative_participant_time": 0,
          "billing_cumulative_participant_time": 0,
          "scheduled_time": 1720695600000,
          "meeting_status": "SCHEDULED",
          "participant_count": 0,
          "active_participant_count": 0,
          "public_session_count": 0,
          "co_browsing_time": 0,
          "client_id": "74c28198-7762-40d3-8925-5cc00dc99e98",
          "notify_meeting_participants": {
            "first": false,
            "second": false
          },
          "co_browsings": [],
          "recordings": [],
          "streamings": [],
          "participant_durations": {},
          "host_room": "82dcc3da-8f70-45fb-ac26-c265af7838f4",
          "view_room": "81f54c1b-664f-460c-8add-e4dabdf2da3f",
          "external_id": "6380dc9b3af94362b7b132d47c13df4f",
          "provider": "",
          "created_on": 1720694557992,
          "updated_on": 1720694558015,
          "source_referrer": "https://jump.saleassist.ai/jump/905002c3-9be6-43fa-8e3d-e71ab0c1d1b7",
          "uid_map": {},
          "followed_up": false,
          "confirmed_at": 0,
          "picked_up_at": 0,
          "participant_exit_times": [],
          "date_time": "2024-07-11T16:30",
          "date_time_ist": "2024-07-11T16:30"
        },
        {
          "message": ""
        }
      ],
      "raw": {},
      "acknowledged": false,
      "is_bot_handover": false,
      "message_to": "a184afcd-6d05-4052-a156-4c057ce723e8",
      "people_id": "9d438aaa-1eaa-496a-a8b3-b4f98367bb0d",
      "meeting_id": "6380dc9b-3af9-4362-b7b1-32d47c13df4f",
      "form_id": "bda6d00a-adf7-409e-8c93-ec08698d0aac",
      "unique_field_value": "+918765875687",
      "source_id": "905002c3-9be6-43fa-8e3d-e71ab0c1d1b7",
      "source_name": "FNP Button test",
      "source_type": "live_call",
      "source_referrer": "https://jump.saleassist.ai/jump/905002c3-9be6-43fa-8e3d-e71ab0c1d1b7",
      "session_id": "e8ebb379-75a9-41e5-8a14-9f8f0842830f",
      "whatsapp_request_id": "",
      "whatsapp_status": {},
      "chat_group_id": "",
      "id": "dc60de93-d726-43cc-ad06-9cc7544cb8e5",
      "is_moderated": false,
      "is_handover_question": false,
      "client_id": "74c28198-7762-40d3-8925-5cc00dc99e98",
      "created_on": 1720694558068,
      "updated_on": 1720694558068,
      "dropped_at": 0,
      "people_detail": {
"name": "Prakash Mudhaliyar",
 "mobile_number": "+910987654321",
 "email": "prakashm@athenabpo.in",
 "address": "Thane",
 "pincode": "400615",
 "utm_campaign": "Test",
 "date_of_month": "28",
  "time_of_day": "15:00",
 "day_of_week": "4",
  "month_of_year": "2022",
  "originated_from": "Test",
  "product_category": "Water Purifier",
  "product_sku": "Test",
  "device": "Mobile",
  "form_fill": "Test",
  "otp_verified": "Yes",
  "extra1": "N1",
  "extra2": "N1",
   "widget_city": "Faridabad",
   "widget_state": "Haryana",
    "widget_country": "India",
    "widget_latitude": 28.4098,
    "widget_longitude": 77.31,
    "widget_ip_address": "103.201.143.23",
    "widget_location_source": "IP ADDRESS"
          "id": "9d438aaa-1eaa-496a-a8b3-b4f98367bb0d"
      },
      "meeting_url": "https://meet.saleassist.ai/82dcc3da-8f70-45fb-ac26-c265af7838f4?user_identity=+918765875687"
    },
    "metadata": {}
  },
  "headers": {
    "content-length": "4482",
    "cdn-loop": "cloudflare",
    "cf-ipcountry": "IN",
    "cf-ray": "8a18301c984c4841-BOM",
    "x-forwarded-proto": "https",
    "x-forwarded-port": "443",
    "x-forwarded-for": "34.93.136.15",
    "accept": "*/*",
    "x-amzn-trace-id": "Root=1-668fb71e-58ab68ae3a48491217fcec09",
    "cf-visitor": "{\"scheme\":\"https\"}",
    "host": "automation.quickwork.co",
    "connection": "close",
    "content-type": "application/json; charset=UTF-8",
    "cf-connecting-ip": "34.93.136.15",
    "accept-encoding": "gzip, br",
    "user-agent": "python-requests/2.31.0"
  },
  "queryString": {}
}

Total Available Webhook Events :-

Enable Webhooks in Dashboard :-

  1. Go to Settings -> API -> Webhooks

  1. Select Webhook event to configure.

  1. Add POST URL, Enable and Save it.

  1. Once webhooks are enabled, please check Audit logs to confirm.

It’s done.

  1. Go to Settings -> API -> Webhooks - mapping

  2. Now select the widget and then clink on Get Schema.

  3. Now create mapping by clicking on + icon and select the fields which you wish to choose.

  4. Once you select the fields, click on the save mappings.

  5. Now add the key and value in the custom headers and add the post call URL and click on Create Webhook.

    And it's done.

WEBHOOK DOCUMENTATION REFERNCE:-

For more details and support, please write us at support@saleassist.ai

PreviousAPI IntegrationNextFAQ & Troubleshooting

Last updated 7 months ago

Was this helpful?

Login to dashboard

https://my.saleassist.ai
redoc
Logo