Operator module

The Operator module lets you track changes related to operators in your SalesIQ portal. You can subscribe to events when an operator is created, updated, deleted, or when they are associated/dissociated from departments.

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 operators' name from the "operator.created" event:

Copied//Syntax
visitor_name = entity.get("<key_name>")
//Example
visitor_name = entity.get("first_name")

Events

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

operator.created

You can subscribe to this event to be notified whenever a new operator is added to your organization.

Payload

Copied{
    "entity_type": "operator",
    "org_id": "15188410",
    "event": "operator.created",
    "entity_id": "115000000029087",
    "attempt": 1,
    "version": "1",
    "entity": {
        "email_id": "patricia@zylker.com",
        "access_levels": [
            "chat",
            "tracking"
        ],
        "role": "Administrator",
        "signature": "2e8132839ffef039e24ab8e162b5b1f1",
        "date_of_birth": "",
        "description": "",
        "language": "",
        "chat_enabled": true,
        "type": "Salesiq User",
        "locale": "",
        "confirmed": false,
        "enabled": true,
        "notify": {
            "return_visit": false,
            "new_visit": false
        },
        "modified_time": "1596093400214",
        "id": "115000000029087",
        "departments": [
            "115000000004001",
            "115000000000018"
        ],
        "first_name": "Patricia",
        "owner": false,
        "created_time": "1596093400198",
        "time_format": "12 hours",
        "address": {
            "country": "",
            "pincode": "",
            "city": "",
            "street": "",
            "state": ""
        },
        "maximum_concurrent_chat": "none",
        "image_url": "",
        "mobile": "",
        "last_name": "",
        "time_zone": "",
        "locale_country": "",
        "deleted": false,
        "phone": "",
        "nick_name": "Patricia",
        "social_media": {
            "twitter": {
                "profile_url": ""
            },
            "linkedin": {
                "profile_url": ""
            },
            "enabled": false
        },
        "status": "Available"
    },
    "event_time": "1596093402483",
   "customer_info": {
   "Branch": "California",
   "Band": "Premium"
  }
}

operator.updated

You can subscribe to this event if you wish to be notified whenever an operator's setting is modified.

Payload

Copied{
    "entity_type": "operator",
    "org_id": "15188410",
    "event": "operator.updated",
    "entity_id": "115000000000094",
    "attempt": 1,
    "version": "1",
    "entity": {
        "email_id": "patricia@zylker.com",
        "access_levels": [
            "chat",
            "tracking"
        ],
        "role": "Administrator",
        "signature": "2e8132839ffef039e7eaaa00748b47ec",
        "date_of_birth": "",
        "description": "",
        "language": "en",
        "chat_enabled": true,
        "type": "Salesiq User",
        "locale": "en",
        "confirmed": true,
        "enabled": true,
        "notify": {
            "return_visit": false,
            "new_visit": false
        },
        "modified_time": "1596092957234",
        "id": "115000000000094",
        "departments": [
            "115000000000018"
        ],
        "first_name": "Patricia",
        "owner": false,
        "created_time": "1594720783132",
        "time_format": "12 hours",
        "address": {
            "country": "us",
            "pincode": "625012",
            "city": "Malibu",
            "street": "Pacific Coast Highway",
            "state": "California"
        },
        "maximum_concurrent_chat": "none",
        "image_url": "",
        "mobile": "08903694722",
        "last_name": "Smith",
        "time_zone": "United States/California",
        "zuid": "15102744",
        "locale_country": "us",
        "deleted": false,
        "phone": "1234567890",
        "nick_name": "Patricia",
        "social_media": {
            "twitter": {
                "profile_url": ""
            },
            "linkedin": {
                "profile_url": ""
            },
            "enabled": false
        },
        "status": "Available"
    },
    "event_time": "1596092957257",
   "customer_info": {
   "Branch": "California",
   "Band": "Premium"
  }
}

operator.deleted

You can subscribe to this event if you wish to be notified when an operator is removed.

Payload

Copied{
    "entity_type": "operator",
    "org_id": "15188410",
    "entity_id": "115000000029087",
    "event": "operator.deleted",
    "version": "1",
    "attempt": 1,
    "event_time": "1596093526367",
   "customer_info": {
   "Branch": "California",
   "Band": "Premium"
  }

}

operator.departments.associated

You can subscribe to this event to be notified whenever an operator is associated with a department.

Payload

Copied{
    "entity_type": "operator",
    "org_id": "15188410",
    "event": "operator.departments.associated",
    "entity_id": "115000000000006",
    "attempt": 1,
    "version": "1",
    "entity": {
        "departments": [
            "115000000004001"
        ],
        "id": "115000000000006"
    },
    "event_time": "1596094781678",
   "customer_info": {
   "Branch": "California",
   "Band": "Premium"
  }
}

operator.departments.dissociated

You can subscribe to this event if you wish to get notified when an operator is removed from a department.

Payload

Copied{
    "entity_type": "operator",
    "org_id": "15188410",
    "event": "operator.departments.dissociated",
    "entity_id": "115000000000006",
    "attempt": 1,
    "version": "1",
    "entity": {
        "departments": [
            "115000000004001"
        ],
        "id": "115000000000006"
    },
    "event_time": "1596094781678",
   "customer_info": {
   "Branch": "California",
   "Band": "Premium"
  }
}