Visitor module

The Visitor module tracks changes to visitor information in real time. This includes updates made to a visitor’s profile, such as name, or email any other data fields captured in SalesIQ.

Payload delivery: Webhooks & Deluge

When a workflow is triggered, the event data is delivered as a payload. The way you access this payload depends on the action platform you choose:

  • Webhooks: The payload is sent as a POST request to the webhook URL you configured. Your external system can read the JSON body to process the event data.
  • Deluge Scripts: The payload is made available through the built-in entity parameter in your script. You can extract specific data using entity object based on the structure of the event.

To get the visitor's name from the event payload:

Copiedvisitor_name = entity.get("<key_name>")
visitor_name = entity.get("first_name")

Events

Here is the list of events supported under the Visitor module. 

  • visitor.updated
    • Case 1: When lead information is updated
    • Case 2: When contact information is added to a lead
    • case 3: When a contact's information is updated

visitor.updated

You can subscribe to this event to be notified when visitor information is updated.

Payload case 1: When lead information is updated

Copied{
    "id": "30000000095001",
    "type": "lead ",
    "first_name": "Scott",
    "last_name": "Smith",
    "modifier": {
        "type": "operator",
        "email_id": "patricia@zylker.com",
        "name": "patricia@zylker.com",
        "id": "30000000099007"
    },
   "customer_info": {
   "Branch": "California",
   "Band": "Premium"
  }
}

Payload case 2: When contact information is added to a lead

Copied{
    "id": "30000000095001",
    "type": "contact",
    "first_name": "Scott",
    "last_name": "Smith",
    "email_id": "scottsmith@zylker.com",
    "phone": "9123459876",
    "lead": {
        "id": "30000000090034"
    },
    "modifier": {
        "type": "operator",
        "email_id": "patricia@zylker.com",
        "name": "patricia@zylker.com",
        "id": "30000000099007"
    },
   "customer_info": {
   "Branch": "California",
   "Band": "Premium"
  }
}

Note: A lead will be converted as a contact when information such as email or phone is provided for the first time.

Payload case 3: When a contact's information is updated

Copied{
    "id": "30000000095001",
    "type": "contact",
    "first_name": "Scott",
    "last_name": "Smith",
    "email_id": "scottsmith@zylker.com",
    "phone": "91234598121",
    "modifier": {
        "type": "operator",
        "email_id": "patricia@zylker.com",
        "name": "patricia@zylker.com",
        "id": "30000000099007"
    },
   "customer_info": {
   "Branch": "California",
   "Band": "Premium"
  }
}