Webhook by Example

Overview

With Dux-Soup Webhooks you can now receive details of various events that occur in Dux-Soup while using the automated or manual profile visits and scan functions. Apart from profile details the webhooks will be sent the details of automated actions, and their results, as they are executed.

Webhooks can be enabled in Dux-Soup Options -> Connect Tab[1]. Simply toggle the switch and set the target URL where you want to receive the data:

Types of Events

The webhook will receive all of the currently available events: Visits, Scans and Actions.

Visit.Create Event

This event occurs when a profile is viewed and has been recognized by Dux-Soup. It will contain most of the profile details. Please also listen for corresponding Update Events to ensure all the captured profile details are received.

Example

This example shows the JSON structure that will be sent as an HTTP POST body to the webhook URL

{
  "userid": "117917531760586753354",			// The current Dux-Soup User
  "time": "2019-01-06T08:45:03.239Z",			// Time when the event was created
  "type": "visit",					// Visit Event
  "event": "create",					// Create Stage
  "data": {						// Profile Details
    "id": "id.11964767",
    "VisitTime": 1546764302571,
    "Profile": "https://www.linkedin.com/in/jamesbrooks3/",
    "Picture": "https://media.licdn.com/dms/image/C4E03AQGS174biYNVOA/profile-displayphoto-shrink_800_800/0?e=1552521600&v=beta&t=yWZVN_trvl0ycueCa4qayoJkVjqhPsuCzgzdQwv90mM",
    "Degree": "1st",
    "First Name": "James",
    "Middle Name": "",
    "Last Name": "Brooks",
    "From": "2018",
    "Title": "CX Innovation",
    "Company": "Capita",
    ...
  }
}

Visit.Update Event

This event occurs when additional profile information becomes available after the initial set. It has the same structure as the Create Event and will include all data from the Create Stage as well as the Update Stage.

Example

{
  "userid": "117917531760586753354",                    // The current Dux-Soup User
  "time": "2019-01-06T08:45:06.233Z",                   // Time when the event was created
  "type": "visit",                                      // Visit Event
  "event": "update",                                    // Update Stage
  "data": {                                             // Profile Details
    "id": "id.11964767",
    "VisitTime": 1546764302571,
    "Profile": "https://www.linkedin.com/in/jamesbrooks3/",
    "Picture": "https://media.licdn.com/dms/image/C4E03AQGS174biYNVOA/profile-displayphoto-shrink_800_800/0?e=1552521600&v=beta&t=yWZVN_trvl0ycueCa4qayoJkVjqhPsuCzgzdQwv90mM",
    "Degree": "1st",
    "First Name": "James",
    "Middle Name": "",
    "Last Name": "Brooks",
    "From": "2018",
    "Title": "CX Innovation",
    "Company": "Capita",
    ...
  }
}

Scan.Create Event

This event occurs when a profile is scanned by Dux-Soup. Scanning profiles is started by the user via the “Scan Profiles” option in the Dux-Soup drop down menu. Each profile in the list that is scanned will result in a single Webhook event.

Example

This example shows the JSON structure that will be sent as an HTTP POST body to the webhook URL

{
  "userid": "117917531760586753354",                    // The current Dux-Soup User
  "time": "2019-01-06T08:45:06.233Z",                   // Time when the event was created
  "type": "scan",                                       // Scan Event
  "event": "create",                                    // Create Stage
  "data": {                                             // Scanned Profile Details
    "id": "id.11964767",
    "ScanTime": 1546764302571,
    "Profile": "https://www.linkedin.com/in/jamesbrooks3/",
    "Degree": "1st",
    "First Name": "James",
    "Middle Name": "",
    "Last Name": "Brooks",
…
}

Action.Create Event

This event occurs when an automated action has completed. The action value can be one of the following, corresponding to the automation actions that are available in Dux-Soup Option:

  •       connectProfile
  •       disconnectProfile
  •       endorseProfile
  •       followProfile
  •       inmailProfile
  •       messageProfile
  •       pdfProfile
  •       saveasleadProfile

Example

This example shows the JSON structure that will be sent as an HTTP POST body to the webhook URL

{
  "userid": "117917536760586753354",			// The current Dux-Soup User
  "time": "2019-01-06T08:45:17.477Z",			// Time when the event was created
  "type": "action",					// Action Event
  "event": "create",					// Create Stage
  "data": {						// Action Details
    "name": "pdfProfile",
    "targeturl": "https://www.linkedin.com/in/jamesbrooks3/",
    "profileid": "id.11964767"
  }
}





[1] Webhooks are only available in Dux-Soup Turbo Edition.

Still need help? Contact Us Contact Us