Exemple de Webhook

Vue d'ensemble

Cette option est disponible pour les utilisateurs Turbo et Cloud qui utilisent Dux-Soup Expert UI.

Avec les Webhooks de Dux-Soup, vous pouvez désormais recevoir les détails de divers événements qui se produisent dans Dux-Soup lors de l'utilisation des fonctions de visite et d'analyse automatisées ou manuelles des profils. Outre les détails des profils, les webhooks recevront les détails des actions automatisées et leurs résultats, au fur et à mesure de leur exécution. Vous pouvez ajouter jusqu'à 5 webhooks, ce qui vous permet d'envoyer différents événements à différentes cibles.

Les Webhooks peuvent être activés dans les Options de Dux-Soup -> Onglet Connect. Il suffit de basculer l'interrupteur et de définir l'URL cible où vous souhaitez recevoir les données :

URL cible

Les données relatives à l'événement seront envoyées à cette adresse web.

Envoyer un échantillon

Appuyez sur ce bouton pour envoyer des échantillons de données des types d'événements sélectionnés à l'URL cible.

Types d'événements

Sélectionnez les événements disponibles que vous souhaitez recevoir.

Visiter
Scanner
Action
Message
Télécommande
Session

Les détails de chacun de ces types d'événements sont présentés ci-dessous.

Visiter l'événement

Les événements de visite se produisent lors de la consultation manuelle et automatique de profils dans LinkedIn.

Visite.Créer un événement

Cet événement se produit lorsqu'un profil est initialement ouvert et reconnu par Dux-Soup. Il contient la plupart des détails du profil. Veuillez également traiter l'événement de mise à jour correspondant pour vous assurer que tous les détails du profil capturés sont reçus.

Exemple

Cet exemple montre la structure JSON qui sera envoyée en tant que corps HTTP POST à l'URL du webhook.

{
  "userid": "117917531760586753354",		// The current Dux-Soup User
  "time": "2019-01-06T08:45:03.239Z",		// 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",
    ...
  }
}

Événement Visit.Update

Cet événement se produit lorsque des informations supplémentaires sur le profil deviennent disponibles après l'envoi de l'événement initial. Il a la même structure que l'événement de création et comprendra toutes les données de la phase de création ainsi que de la phase de mise à jour.

Exemple

{
  "userid": "117917531760586753354",                // The current Dux-Soup User
  "time": "2019-01-06T08:45:06.233Z",               // 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",
    ...
  }
}

Événement de balayage

Les événements de numérisation se produisent lorsque Dux-Soup traite une liste de profils, après que l'utilisateur a sélectionné "Numériser les profils".

Événement Scan.Create

Cet événement se produit lorsqu'un profil est scanné par Dux-Soup. Le balayage des profils est lancé par l'utilisateur via l'option "Scan Profiles" dans le menu déroulant de Dux-Soup. Chaque profil de la liste qui est scanné donnera lieu à un événement Webhook unique.

Exemple

Cet exemple montre la structure JSON qui sera envoyée en tant que corps HTTP POST à l'URL du webhook.

{
  "userid": "117917531760586753354",                // The current Dux-Soup User
  "time": "2019-01-06T08:45:06.233Z",               // 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/",
    "First Name": "James",
    "Middle Name": "",
    "Last Name": "Brooks",
    ...
}

Événements d'action

Les événements d'action se produisent lorsque les automatismes de Dux-Soup, par exemple l'auto-invitation, l'auto-endorse, sont déclenchés sur un profil.

Événement Action.Create

Cet événement se produit lorsqu'une action automatisée est terminée. Le nom de l'action peut être l'un des suivants, correspondant aux actions d'automatisation disponibles dans Dux-Soup Option :

profil de connexion
profil de déconnexion
endorseProfile
suivreProfil
inmailProfile
profil de message
pdfProfil
Sauvegarder un profil de chef de file

Exemple

Cet exemple montre la structure JSON qui sera envoyée en tant que corps HTTP POST à l'URL du webhook.

{
  "userid": "117917536760586753354",		// The current Dux-Soup User
  "time": "2019-01-06T08:45:17.477Z",		// 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",
    "successflag": true,			// Success indicator
    "returnvalue": null				// Return value, if any
  }
}

Message Events

Les événements de messages se produisent lorsque le pont de messages a été activé et que de nouveaux messages sont traités par Dux-Soup.

Événement Message.Received

Cet événement se produit lorsqu'un nouveau message reçu a été lu par le pont de messages. Le type de message peut être l'un des suivants, correspondant au type de message qui a été lu dans la boîte de réception LinkedIn.

MEMBRE_À_MEMBRE
INVITATION_ACCEPT
INMAIL

Exemple

Cet exemple montre la structure JSON qui sera envoyée en tant que corps HTTP POST à l'URL du webhook.

{
  "userid": "117917536760586753354",		// The current Dux-Soup User
  "time": "2019-03-21T16:51:25.899Z",		// When the event was created
  "type": "message",				// Message Event
  "event": "received",				// Received message
  "data": {
    "url": 					// the conversation on LinkedIn
	   "https://www.linkedin.com/messaging/thread/64525225672721408/", 	
    "timestamp": "2019-02-15T15:28:20.980Z",	// Timestamp of the message
    "from": 					// Message sender LinkedIn URL
	     "https://www.linkedin.com/in/rodrigo-ramos-a0ab9327", 
    "fromId": "id.26429462492",			// Message sender profile id
    "fromFirstName": "Rodrigo",			// Message sender first name
    "fromLastName": 	"Ramos",		// Message sender last name
    "type": "MEMBER_TO_MEMBER",			// Type of message
    "tags": [	"🦆-default-invited", 
	 	"🦆-default-accepted" , 
		"🦆-default-responded"   ],	// Tags on the profile 
    "text": 					// Message body
	    "Hi man. You’re Welcome. Nice to have you in my contacts" 	
  }
}

Événement Message.Sent

Cet événement se produit lorsqu'un nouveau message envoyé a été lu par la passerelle de messages. Le type de message est MEMBER_TO_MEMBER.

Exemple

Cet exemple montre la structure JSON qui sera envoyée en tant que corps HTTP POST à l'URL du webhook.

{
  "userid": "117917536760586753354",		// The current Dux-Soup User
  "time": "2019-03-21T16:51:25.899Z",		// When the event was created
  "type": "message",				// Message Event
  "event": "sent",				// Sent message
  "data": {
    "url": 					// the conversation on LinkedIn
	   "https://www.linkedin.com/messaging/thread/64525225672721408/", 	
    "timestamp": "2019-02-15T15:28:20.980Z",	// Timestamp of the message
    "to": 					// Message sender LinkedIn URL
	     "https://www.linkedin.com/in/rodrigo-ramos-a0ab9327", 
    "toId": "id.26429462492",			// Message recipient profile id
    "toFirstName": "Rodrigo",			// Message recipient first name
    "toLastName": 	"Ramos",		// Message recipient last name
    "type": "MEMBER_TO_MEMBER",			// Type of message
    "tags": [	"🦆-default-invited", 
		"🦆-default-accepted"   ],	// Tags on the profile 
    "text": 					// Message body
	    "Hi Rodrigo, what are you up to these days?" 	
  }
}

Événements de contrôle à distance

Les événements de télécommande se produisent lorsque le robot télécommandé traite des commandes.

Événement RCCommand.received

Cet événement se produit lorsqu'une nouvelle commande de télécommande a été lue par le robot de télécommande.

Exemple

Cet exemple montre la structure JSON qui sera envoyée en tant que corps HTTP POST à l'URL du webhook.

{
  "userid": "117917536760586753354",		// The current Dux-Soup User
  "time": "2019-03-25T14:13:15.814Z",		// When the event was created
  "type": "rccommand",
  "event": "received",
  "data": {
    "id": "a5f64143-b847-5f473ac7488d",
    "command": "visit",
    "params": {
      "profile": "https://www.linkedin.com/in/janjanjanjanjan/"
    }
  }
}

Événement RCCommand.completed

Cet événement se produit lorsqu'une commande de télécommande a été exécutée avec succès par le robot télécommandé.

RCCommand.snooze Event

Cet événement se produit lorsque le robot de commande à distance s'endort en raison de la configuration de l'étranglement.

Exemple

Cet exemple montre la structure JSON qui sera envoyée en tant que corps HTTP POST à l'URL du webhook.

{
  "userid": "103329626217674043154",		// The current Dux-Soup User
  "time": "2019-04-20T10:48:35.828Z",		// When the event was created
  "type": "rccommand",
  "event": "snooze",
  "data": {
    "reason": "throttling",
    "time": 15000
  }
}

Événement RCCommand.ready

Cet événement se produit lorsque le robot télécommandé est prêt à recevoir des commandes.

Exemple

Cet exemple montre la structure JSON qui sera envoyée en tant que corps HTTP POST à l'URL du webhook.

{
  "userid": "117917536760586753354",		// The current Dux-Soup User
  "time": "2022-06-25T14:13:15.814Z",		// When the event was created
  "type": "rccommand",
  "event": "ready",
  "data": {
      "clientid":"203bc8fa-13e9-4efe-b0e1-26a4067c5c6e",
      "exclusions":{
         "commands":[], // list of commands to be excluded due to throttling
         "campaigns":[	// list of disabled campaign ids
            "default"
         ]
  }
}

RCCommand.ignore Event

Cet événement se produit lorsqu'une commande a été ignorée. Cela se produit lorsque le profil de la cible correspond à l'une des règles d'exclusion d'action, par exemple la liste noire.

Exemple

Cet exemple montre la structure JSON qui sera envoyée en tant que corps HTTP POST à l'URL du webhook.

{
    "userid" : "103329626217674043154",		// The current Dux-Soup User
    "time" : "2022-04-28T08:18:14.221Z",	// When the event was created
    "type" : "rccommand",
    "event" : "ignore",
    "data" : {
        "id" : "a7f8508d-bae9-2caafac11c66",
        "command" : "message",
        "params" : {
            "profile" : "https://www.linkedin.com/in/janjanjanjanjan/",
            "messagetext" : "Hi _FN_,\n\nThanks for connecting.",
            "campaignid" : "default",
        },
        "reason" : "blacklisted"
    }
}

Événement RCCommand.error

Cet événement survient lorsqu'une erreur s'est produite lors de l'exécution de la commande de contrôle à distance.

Exemple

Cet exemple montre la structure JSON qui sera envoyée en tant que corps HTTP POST à l'URL du webhook.

{
    "userid" : "103329626217674043154",		// The current Dux-Soup User
    "time" : "2022-04-28T12:35:03.878Z",	// When the event was created
    "type" : "rccommand",
    "event" : "error",
    "data" : {
        "id" : "86082680-b3c1-7e704c999d67",
        "command" : "connect",
        "params" : {
            "profile" : "https://www.linkedin.com/in/janjanjanjanjan/",
            "campaignid" : "playbook",
            "messagetext" : "Hi _FN_,\n\nLet's connect."
        },
        "error" : "selector '*[type=connect-icon],.pvs-profile-actions__action.artdeco-button--primary[0] not found within timeout."
    }
}

Événements de la session

Les événements de session se produisent lorsque l'extension Dux-Soup est lancée et lorsque le statut de la session LinkedIn de l'utilisateur change.

Événement Session.Create

Cet événement est déclenché au début du démarrage de l'extension.

Exemple

Cet exemple montre la structure JSON qui sera envoyée en tant que corps HTTP POST à l'URL du webhook.

{
    "userid" : "103329626277674043154",		// The current Dux-Soup User
    "time" : "2024-02-06T18:59:36.443Z", 	// When the event was created
    "type" : "session",
    "event" : "create",
    "data" : {
        "username" : "",                        // LinkedIn user
        "profile" : "",                         // LinkedIn profile
        "cloudsession" : false,                 // cloud or local
        "loggedin" : false,                     // logged into Linkedin?
        "paused" : false                        // extension paused?
    },
}

Événement Session.Update

Cet événement se produit lorsque quelque chose change dans l'état de la session LinkedIn de l'extension, ou lorsque l'extension est mise en pause ou désactivée via l'API.

Exemple

Cet exemple montre la structure JSON qui sera envoyée en tant que corps HTTP POST à l'URL du webhook.

{
    "userid" : "103329626277674043154",		// The current Dux-Soup User
    "time" : "2024-02-06T19:09:33.212Z", 	// When the event was created
    "type" : "session",
    "event" : "update",
    "data" : {
        "username" : "John Doe",                 // LinkedIn user
        "profile" : "https://www.linkedin.com/in/john-doe-381910160",
        "cloudsession" : false,                  // cloud or local
        "loggedin" : true,                       // logged into Linkedin?       
        "paused" : false                         // extension paused?
    },
}