CommBox Webhooks
    • 16 Jun 2024
    • 15 Minutes to read
    • Contributors
    • Dark
      Light
    • PDF

    CommBox Webhooks

    • Dark
      Light
    • PDF

    Article summary

    Webhooks Module PNG.png
    Available Webhooks

    Overview

    Below is a short description of every available Webhook including a JSON payload example. Select the desired webhook from the side bar menu.

    For explanation of terms related to Webhooks, click here.
    For a guide on creating a subscription in our automated system. Click here.
    For our Developer Center, click here.

    Triggers associated with the Object entity:

    OnNew

    This event is triggered when a new conversation (object) is created. Payload includes the initial contact information (message, right/left justification, language, URL of origin), user information (Channel used, basic information), and information about the conversation (ID, Stream ID, stream Type- see Enum)

    Payload Example:

    {
      "payload": {
        "Message": "FirstMessage",
        "Content": {
          "guidRT": "b9656718e9614ab99326ff7e766e9167",
          "languages": [
            {
              "Item1": "en",
              "Item2": 3377699720698044
            }
          ],
          "originUrl": "https://apps.commbox.io/innerDemo",
          "ruleLastMessageFromCustomer": true,
          "isConnected": true
        },
        "ManagerId": "0",
        "Snippet": "FirstMessage",
        "User": {
          "Content": {},
          "Identity": {
            "Id": "3377699720580841",
            "StreamProviderId": "5b3afd9e-1e10-48e4-b84c-7e0c0e1354a9",
            "StreamProviderType": "6",
            "StreamProviderEmail": "",
            "UserName": "",
            "FirstName": "",
            "LastName": "",
            "ThumbnailUrl": ""
          },						
          "Id": "3377699720575710",
          "Phone1": "",
          "Phone2": "",
          "UniqueID": "",
          "Email": "",
          "FirstName": "",
          "LastName": "",
          "NumIdentities": "1",
          "Locale": "",
          "Remarks": "",
          "NumObjects": "1"
        },
        "Id": "3377699720568713",
        "StreamId": "24569",
        "SubStreamId": "0",
        "Type": "4",
        "StatusID": "1",
        "CreateDate": "09-06-2024 07:28:47",
        "StreamProviderId": "",
        "StreamProviderType": "BumpYard"
      }
    }
    

    OnNewChild

    This event is triggered when a new message (Child) is created in the conversation.
    Payload includes the content of the message (hello world), the agent information, the customer file, and the conversation and channel IDs.

    Payload Example:

    {
      "payload": {
        "Message": "Hello World",
        "Content": {
          "languages": [
            {
              "Item1": "en",
              "Item2": 1366764
            }
          ],
          "ruleLastMessageFromCustomer": true
        },
        "ManagerId": "0",
        "Snippet": "Hello World",
        "User": {
          "Content": {
            "Test": "",
            "sanity1406": "",
            "DEMO": "",
            "ID": "",
            "Input_Name_1": ""
          },
          "Identity": {
            "Id": "546374",
            "StreamProviderId": "972539640001",
            "StreamProviderType": "5",
            "StreamProviderEmail": "",
            "UserName": "Mendy Doe",
            "FirstName": "Mendy",
            "LastName": "Doe",
            "ThumbnailUrl": ""
          },
          "Id": "537520",
          "Phone1": "972539640001",
          "Phone2": "",
          "UniqueID": "",
          "Email": "mendyDoe123@gmail.com",
          "FirstName": "Mendy",
          "LastName": "Doe",
          "NumIdentities": "2",
          "Locale": "",
          "Remarks": "",
          "NumObjects": "67"
        },
        "Id": "381226",
        "StreamId": "1772",
        "SubStreamId": "0",
        "Type": "0",
        "StatusID": "1",
        "CreateDate": "16-06-2024 08:35:11",
        "StreamProviderId": "972539640281_by_24",
        "StreamProviderType": "WhatsApp"
      }
    }
    
    

    OnNewActivity

    This trigger has many Types of activities that can occur during or related to a conversation. The Type is presented as a number and is listed in the Enums.

    Every payload ends with the Conversation ID and the channel (and sub channel) the activity took place in.

    A. New remark activity

    [ObjectActivityType = 1]
    This event is triggered when a new remark is added to the conversation.

    Payload Example (JSON):

    {
      "payload": {
        "Activities": {
          "Activity": {
            "User": {
              "Identity": {
                "Id": "24317951"
              },
              "Id": "23571562"
            },
            "Data": {
              "text": "Message On Remark"
            },
            "Id": "3377699720762016",
            "Type": "1",
            "CreateDate": "09-06-2024 07:32:00"
          }
        },
        "Id": "3377699720568713",
        "StreamId": "24569",
        "SubStreamId": "0"
      }
    }
    

    B. Status change activity

    [ObjectActivity Type = 2]
    This event is triggered when the Object Status is changed. See Enums for specific code definitions at the Enums section of this document.

    Payload includes the User ID, The status ID, conversation ID, and channel (stream) information.
    Payload Example (JSON):

    {
      "payload": {
        "Activities": {
          "Activity": {
            "User": {
              "Identity": {
                "Id": "24317951"
              },
              "Id": "23571002"
            },
            "Data": {
              "statusId": 2,
              "requestEnvironment": "Manage",
              "requestIp": "213.57.31.162"
            },
            "Id": "3377699720762017",
            "Type": "2",
            "CreateDate": "09-06-2024 07:33:15"
          }
        },
        "Id": "3377699720568713",
        "StreamId": "24569",
        "SubStreamId": "0"
      }
    } 
    

    C. Object forward activity

    [Object Activity Type =3]
    This event is triggered when the conversation is forwarded to another email.
    image.png

    image.png

    Payload includes the recipient’s email address, and whether to allow a response or attachments from the recipient (checked box in the system).
    Payload Example (JSON):

    {
      "payload": {
        "Activities": {
          "Activity": {
            "User": {
              "Identity": {
                "Id": "24317951"
              },
              "Id": "23571562"
            },
            "Data": {
              "message": "SimpleTexts",
              "recipients": [
                "testmail@commbox.io"
              ],
              "allowEmailReply": true,
              "allowCustomerDetails": true,
              "attachments": []
            },
            "Id": "3377699720762019",
            "Type": "3",
            "CreateDate": "09-06-2024 07:35:14"
          }
        },
        "Id": "3377699720568713",
        "StreamId": "24569",
        "SubStreamId": "0"
      }
    }
    

    D. Reply to Forward Object activity

    [Object Activity Type =4]
    When a conversation is forwarded to another email, this event is triggered when a response comes back from that email address.

    Payload Example (JSON):

    {
      "payload": {
        "Activities": {
          "Activity": {
            "User": {
              "Id": "0"
            },
            "Data": {
              "message": "TestMessage",
              "recipients": [
                "testmail@commbox.io"
              ],
              "attachments": "null"
            },
            "Id": "3377699720762021",
            "Type": "4",
            "CreateDate": "09-06-2024 07:40:38"
          }
        },
        "Id": "3377699720568712",
        "StreamId": "24569",
        "SubStreamId": "0"
      }
    }
    

    E. Object Stream Change

    [Object Activity Type =5]
    This event is triggered when the conversation's communication channel changes to a different channel. In the example below, once the conversation left the Chat-General channel, the webhook was sent. Payload includes the agent’s ID and the channel of origin and destination channel.
    Also see Object - Target Stream Change activity, which has the same payload, but the trigger is the channel the conversation came to.

    Payload Example (JSON):
    Object - OnNewActivity – ObjectStreamChange

    {
      "payload": {
        "Activities": {
          "Activity": {
            "User": {
              "Identity": {
                "Id": "24317951"
              },
              "Id": "23571562"
            },
            "Data": {
              "oldObjectStreamName": "Chat General",
              "oldObjectStreamId": 24569,
              "newObjectStreamName": "Chat Payments",
              "newObjectStreamId": 15802,
              "newObjectSubstreamName": "",
              "newObjectSubstreamId": 0,
              "requestEnvironment": 2,
              "requestIp": [
                "213.57.31.162"
              ]
            },
            "Id": "3377699720762022",
            "Type": "5",
            "CreateDate": "09-06-2024 07:46:06"
          }
        },
        "Id": "3377699720568712",
        "StreamId": "15802",
        "SubStreamId": "0"
      }
    

    F. New Manager Assignment

    [Object Activity Type = 6]
    This event is triggered when an agent is assigned to the conversation. The Payload includes the User (agent) ID and the assigned conversation details.

    Payload Example (JSON):

     
    {
      "payload": {
        "Activities": {
          "Activity": {
            "User": {
              "Identity": {
                "Id": "24317951"
              },
              "Id": "23571002"
            },
            "Data": {
              "managerId": 23571002,
              "assignedManagerId": 23571002,
              "assignedManagerUserName": ""
            },
            "Id": "3377699720762030",
            "Type": "6",
            "CreateDate": "09-06-2024 11:40:56"
          }
        },
        "Id": "3377699720568715",
        "StreamId": "15802",
        "SubStreamId": "30901"
      }
    }
    

    G. Update object tag

    [Object Activity Type = 7]
    This event is triggered when a tag is added to (or removed from) the conversation. Adding a tag is accomplished by clicking the tags icon in the Reply box and selecting a tag from the menu. Removing a tag is done by hovering over the tag at the top of the conversation pane, and clicking the small X.

    The payload includes the tag’s ID, related conversation’s ID, tagging agent’s ID, Tag’s name and related group (if any). When a tag is removed from a conversation, the field “isRemoveTag” will be true.
    image.png

    image.png

    Payload Example (JSON):

    {
      "payload": {
        "Activities": {
          "Activity": {
            "User": {
              "Identity": {
                "Id": "24317951"
              },
              "Id": "23571562"
            },
            "Data": {
              "tagId": 3377699720531414,
              "objectId": 3377699720567827,
              "managerId": 23571002,
              "isRemoveTag": false,
              "name": "ffff",
              "group_name": ""
            },
            "Id": "3377699720762037",
            "Type": "7",
            "CreateDate": "09-06-2024 11:46:52"
          }
        },
        "Id": "3377699720567827",
        "StreamId": "24569",
        "SubStreamId": "0"
      }
    }
    

    H. Follow-up Object Activity

    [Object Activity Type = 8]
    This event is triggered when a snoozed conversation reappears in the inbox.

    Payload Example (JSON):

    {
      "payload": {
        "Activities": {
          "Activity": {
            "User": {
              "Identity": {
                "Id": "24317951"
              },
              "Id": "23571002"
            },
            "Data": {
              "text": "",
              "scheduledTime": "06/09/2024 11:55:00",
              "requestEnvironment": "Manage",
              "requestIp": "213.57.31.162"
            },
            "Id": "3377699720762040",
            "Type": "8",
            "CreateDate": "09-06-2024 11:54:37"
          }
        },
        "Id": "3377699720568715",
        "StreamId": "15802",
        "SubStreamId": "30901"
      }
    }
    

    I. Update Object Attachments

    [Object Activity Type = 10]
    This event is triggered when an attachment is added to the remark section in the reply box.

    Note: Attachments sent to the customer or received by the agent do not trigger this webhook.

    Payload Example (JSON):

    {
      "payload": {
        "Activities": {
          "Activity": {
            "User": {
              "Identity": {
                "Id": "24317951"
              },
              "Id": "23571002"
            },
            "Data": {
              "attachments": [
                {
                  "href": "DocsAttachmentRemarks.png",
                  "name": "attached file",
                  "size": 302442
                }
              ]
            },
            "Id": "3377699720762048",
            "Type": "10",
            "CreateDate": "09-06-2024 12:14:18"
          }
        },
        "Id": "3377699720568729",
        "StreamId": "24569",
        "SubStreamId": "0"
      }
    }
    

    J. Invalid Extension File

    [Object Activity Type = 15]
    This event is triggered when there is an attempt to upload an incompatible file extension. For example, the Doc extension was turned off in the Privacy and Security module. When the customer attempts to upload a doc file, a webhook will be triggered (and the upload will fail).

    To enable or disable file extensions, navigate to Settings > Privacy and Security module, expand the Media section, and check the desired formats.
    image.png

    Payload Example (JSON):

    {
      "payload": {
        "Activities": {
          "Activity": {
            "User": {
              "Id": "0"
            },
            "Data": {
              "status": "failed",
              "description": "Unsupported file type: application/msword extension: doc",
              "invalidActivity": 15,
              "fileExtension": "doc"
            },
            "Id": "3377699720762058",
            "Type": "15",
            "CreateDate": "09-06-2024 12:35:54"
          }
        },
        "Id": "3377699720568732",
        "StreamId": "10470",
        "SubStreamId": "0"
      }
    }
    

    K. Invalid File Size

    [Object Activity Type = 16]
    This event is triggered when the attachment file being uploaded is above the allowable size as determined in the Privacy and Security module. To change the file size limits (in MB), navigate to Settings > Privacy and Security module, expand the Media section, and enter the desired limit.

    The payload includes the allowable maximum size and the conversation’s details.

    Payload Example (JSON):

    {
      "payload": {
        "Activities": {
          "Activity": {
            "User": {
              "Id": "0"
            },
            "Data": {
              "status": "failed",
              "description": "File is too big",
              "maxFileSizeAllow": 1,
              "invalidActivity": 16
            },
            "Id": "3377699720762062",
            "Type": "16",
            "CreateDate": "09-06-2024 13:02:11"
          }
        },
        "Id": "3377699720568732",
        "StreamId": "10470",
        "SubStreamId": "0"
      }
    }
    

    l. Unallowed File Upload

    [Object Activity Type = 17]
    This event is triggered when a customer or an agent attempts to upload a file type that is not approved in the Privacy and Security section of the communication channel.

    To enable or disable file formats, navigate to Settings and click on the communication Module (Chat, WhatsApp, etc.) At the specific module, select the desired channel, expand the Privacy and Security section, and check the Allowed file types for the customer and the agent. Click Save at the bottom of the page to save your settings.

    image.png

    Payload Example (JSON):

    {
      "payload": {
        "Activities": {
          "Activity": {
            "User": {
              "Id": "0"
            },
            "Data": {
              "status": "failed",
              "description": "media dos not enabled",
              "invalidActivity": 17
            },
            "Id": "3377699720762070",
            "Type": "17",
            "CreateDate": "09-06-2024 13:14:27"
          }
        },
        "Id": "3377699720568732",
        "StreamId": "10470",
        "SubStreamId": "0"
      }
    }
    

    M. Participant Change

    [Object Activity Type = 19]
    This event is triggered when a participant (not the agent assigned) is added to the conversation. The Payload includes the name of the added participant.
    image.png

    Payload Example (JSON):

    {
      "payload": {
        "Activities": {
          "Activity": {
            "User": {
              "Identity": {
                "Id": "24317951"
              },
              "Id": "23571002"
            },
            "Data": {
              "action": "addParticipant",
              "performingAgentId": 23571002,
              "isAgent": true,
              "addedParticipantName": "Michael Rebon"       
            },
            "Id": "3377699720762071",
            "Type": "19",
            "CreateDate": "09-06-2024 13:16:29"
          }
        },
        "Id": "3377699720568732",
        "StreamId": "10470",
        "SubStreamId": "0"
      }
    }
    

    N. Target Stream Change

    [Object Activity Type = 20]
    This event is triggered when the current channel receives a conversation from another channel. For example, in the example below, the conversation is currently in the Chat Payments channel and will trigger a webhook since it came from another channel.
    See also Object-ObjectStreamChange activity webhook which has the same payload but is triggered by the changing of the original channel.

    Payload Example (JSON):
    Object - OnNewActivity – ObjectStreamChange

    {
      "payload": {
        "Activities": {
          "Activity": {
            "User": {
              "Identity": {
                "Id": "24317951"
              },
              "Id": "23571562"
            },
            "Data": {
              "oldObjectStreamName": "Chat General",
              "oldObjectStreamId": 24569,
              "newObjectStreamName": "Chat Payments",
              "newObjectStreamId": 15802,
              "newObjectSubstreamName": "",
              "newObjectSubstreamId": 0,
              "requestEnvironment": 2,
              "requestIp": [
                "213.57.31.162"
              ]
            },
            "Id": "3377699720762022",
            "Type": "5",
            "CreateDate": "09-06-2024 07:46:06"
          }
        },
        "Id": "3377699720568712",
        "StreamId": "15802",
        "SubStreamId": "0"
      }
    

    O. Conversation Summary

    [Object Activity Type = 21]
    This event is triggered when the conversation is summarized by the system using our AI features.

    Payload Example (JSON):

    {
      "payload": {
        "Activities": {
          "Activity": {
            "User": {
              "Identity": {
                "Id": "24317951"
              },
              "Id": "23571002"
            },
            "Data": {
              "customerDetails": {
                "email": "test@gmail.com"
              },
              "conversationDetails": {
                "objectId": 3377699720567742,
                "createdTime": "2024-06-02T15:47:50",
                "firstResponseTime": "2024-06-02T15:48:11",
                "streamName": "Chat V2.0",
                "fullName": "Menny Rose",                        
                "summarizedByCommBoxAI": "1"                              
              },
              “text”: ”-**Customer approached CS to transfer device installed in his car to his name.**\n\n-**Action Items Taken:**\n Device was transferred to car owner based on his request. Welcome message sent with details of transactions and applicable terms.\n\n- Continued Service:\n – Customer may contact the calling center via phone or WA during business hours. Suggestions applicable if customer has additional questions or concerns.”
            },
            "Id": "3377699720762074",
            "Type": "21",
            "CreateDate": "09-06-2024 13:21:49"
          }
        },
        "Id": "3377699720567742",
        "StreamId": "15802",
        "SubStreamId": "0"
      }
    }
    
    

    P. Redact Child

    [Object Activity Type = 23]
    This event is triggered when a message or part of a message in the conversation is deleted/blocked from view.

    redactchild.png

    Payload Example (JSON):

    	{
      "payload": {
        "Activities": {
          "Activity": {
            "User": {
              "Identity": {
                "Id": "24317951"
              },
              "Id": "23571002"
            },
            "Data": {},
            "Id": "3377699720762075",
            "Type": "23",
            "CreateDate": "09-06-2024 13:23:37"
          }
        },
        "Id": "3377699720567742",               
        "StreamId": "15802",
        "SubStreamId": "0"
      }
    }
    

    On Update Tag

    This Event is triggered when a tag is Added or Removed from the conversation (object). Payload included the action and the tag ID.

    Payload Example (JSON):

    {
      "payload": {
        "Tags": {
          "Tag": {
            "Id": "3377699720528304",
            "Action": "Add"
          }
        },
        "Id": "3377699720568732",
        "StreamId": "11508",
        "SubStreamId": "0"
      }
    }
    

    OnAssign

    This Event is triggered when the agent is manually assigned to a conversation. Payload includes the conversion ID, and the channel (stream) Id.
    Payload Example (JSON):

    {
      "payload": {
        "Id": "3377699720568729",
        "StreamId": "24569",
        "SubStreamId": "0"
      }
    }
    

    OnUnAssign

    This Event is triggered when the agent is manually unassigned from a conversation. Payload includes the conversion ID, and the channel (stream) Id.
    Payload Example (JSON):

    {
      "payload": {
        "Id": "3377699720568729",
        "StreamId": "24569",
        "SubStreamId": "0"
      }
    }
    

    Triggers associated with the User entity:

    OnNew

    This event is triggered by the creation of a new user (an agent). The payload includes the new user ID and the initial information collected by the system.

    Payload Example (JSON):

    
    {
      "payload": {
        "Content": {},
        "Id": "3377699720575719",
        "Phone1": "",
        "Phone2": "",
        "UniqueID": "",
        "Email": "NewUser@gmail.com",
        "FirstName": "",
        "LastName": "",
        "NumIdentities": "1",
        "Locale": "he_IL",
        "Remarks": ""
      }
    }
    

    OnUpdate

    This event is triggered by an update of a user at the Customer Info pane in the Conversations window.

    Note: The ID field relates to the user Id generated by the system, while the UniqueID is entered by the agent.

    image.png

    Payload Example (JSON):

    {
      "payload": {
        "Content": {},
        "Id": "3377699720575719",
        "Phone1": " 19175012555",
        "Phone2": "",
        "UniqueID": "01234512367",
        "Email": " John1Doe2@gmail.com",
        "FirstName": "John",
        "LastName": "Doe",
        "NumIdentities": "1",
        "Locale": "en_US",
        "Remarks": ""
      }
    }
    

    Login

    This event is triggered when an agent logs in to the CommBox platform.
    Payloads includes the agent’s information, activation state, and set location and language.

    Payload Example (JSON):

    {
      "payload": {
        "Content": {
          "_isEmailVerified": true,
          "_activationState": "Handled"
        },
        "Id": "23571002",
        "Phone1": "17181234567",
        "Phone2": "",
        "UniqueID": "",
        "Email": "bestagent@commbox.io",
        "FirstName": "Best",
        "LastName": "Agent",
        "NumIdentities": "1",
        "Locale": "he_IL",
        "Remarks": ""
      }
    }
    

    Logout

    This event is triggered when an agent logs out to the CommBox platform.
    Payloads includes the agent’s information, activation state, and set location and language.

    Payload Example (JSON):

    {
      "payload": {
        "Content": {
          "_isEmailVerified": true,
          "_activationState": "Handled"
        },
        "Id": "23571002",
        "Phone1": "17181234567",
        "Phone2": "",
        "UniqueID": "",
        "Email": "bestagent@commbox.io",
        "FirstName": "Best",
        "LastName": "Agent",
        "NumIdentities": "1",
        "Locale": "he_IL",
        "Remarks": ""
      }
    }
    

    Triggers associated with the Satisfaction entity:

    On Submit

    This event is triggered when a satisfaction survey is submitted.
    Note that open-ended questions will NOT trigger a webhook, but EVERY closed-ended question will send one.

    Payload includes the score selected with its description, as set in the Customer Satisfaction module.

    Payload Example (JSON):

    {
      "payload": {
        "Score": "50",
        "Description": "good",
        "ObjectId": "3377699720568738"
      }
    }
    

    Triggers associated with the Tag entity:

    The OnNewActivity events in the Object entity cover tags related to the conversation where agents add or remove tags to the conversation to trigger the webhook.

    In this category, webhooks are triggered when tags are created or updated in the tags section of the Organization’s settings.

    OnAdd

    This event is triggered when a new tag is added to the system.

    image.png

    Payload includes the new Tag’s ID, if it belongs to a group (if not in a group, value = 0), its name, label (conversation and/or user), type (Tag/Goal/Miss – see Enums at the end of this document), and value details (where applicable).
    Payload Example (JSON):

    {
      "payload": {
        "eventName": "OnAdd",
        "tagId": "3377699720535050",
        "groupId": "0",
        "name": "TestADD",
        "isObject": "True",
        "isUser": "False",
        "type": "1",
        "unit": "0",
        "unitValidationType": "0",
        "unitValidation": "",
        "defaultValue": ""
      }
    }
    

    On Update

    This event is triggered when a tag is updated in the Tags section of the Organization settings. Clicking on the tag itself opens the update window enabling changing its name or values, adding it to a certain group, etc.

    image.png

    Payloads includes the Tag’s ID, and its updated group, name, label (conversation and/or user), type (Tag/Goal/Miss – see Enums section), value details (where applicable).

    Payload Example (JSON):

    {
      "payload": {
        "eventName": "OnUpdate",
        "tagId": "27949",
        "groupId": "3377699720528190",
        "name": "value 112",
        "isObject": "True",
        "isUser": "False",
        "type": "1",
        "unit": "1",
        "unitValidationType": "1",
        "unitValidation": {
          "min": "1",
          "max": "1111"
        },
        "defaultValue": "10"
      }
    }
    

    On Delete

    This event is triggered when a tag is deleted from the Tags section of the Organization settings.

    Payload Example (JSON):

    {
      "payload": {
        "eventName": "OnDelete",
        "tagId": "21958"
      }
    }
    

    On Add Group

    This event is triggered when a new tag group is created in the Tags section of the Organization settings. Payload includes the new group name and its group ID. Once created, you can add new and existing tags to this group via the AddTag and UpdateTag functionalities.

    image.png

    Payload Example (JSON):

      "payload": {
        "eventName": "OnAddGroup",
        "groupId": "3377699720531126",
        "name": "TestAddGroup"
      }
    

    On Update Group

    This event is triggered when the name of a tag group is updated by clicking on it in the Tags section of the Organization settings. Once clicking anywhere away from the edited tag, the webhook will be send.

    image.png

    On Delete Group

    This event is triggered when a tag group is deleted from the Tags section of the Organization settings by hovering over its name and clicking the X on it. The payload includes the group ID that was deleted.

    image.png

    Payload Example (JSON):

    {
      "payload": {
        "groupId": "3377699720531126"
      }
    }
    

    Triggers associated with the Form entity:

    On Submit

    This event is triggered when a customer submits a form.
    The conversation ID (object ID) and the Form’s URL are included in the payload.

    Payload Example (JSON):

    {
      "payload": {
        "ObjectId": "3377699720568739",
        "FormUrl": "https://qaqa.commbox.io/media/brands/qaqa/forms/6-24/a80e4081dc.pdf",
        "Properties": {
          "field_0": "TESTNAME",
          "field_1": "true"
        }
      }
    }
    

    Triggers associated with the Chat entity:

    On User Exit

    This event is triggered when the customer closes the chat window or disconnects.
    User Id and conversation Id (CommBox generated number) are listed.

    Payload Example (JSON):

    {
      "payload": {
        "User": {
          "Id": "3377699720575717"
        },
        "Object": {
          "Id": "3377699720568729"
        }
      }
    } 
    

    ENUMS:

    ObjectActivityType

    Remark = 1
    StatusChange = 2
    Forward = 3
    ReplyToForwardedObject = 4
    StreamChange = 5
    NewManagerAssignment = 6
    UpdateObjectTag = 7
    FollowUp = 8
    UpdateObjectAttachment = 10
    InvalidExtensionFile = 15
    InvalidFileSize = 16
    DisallowedFileUpload = 17
    inactivityLogout = 18
    ParticipantChange = 19
    TargetStreamChange = 20
    ConversationSummary = 21
    RedactChild = 23

    ObjectStatusType

    Open = 1
    Resolved = 2
    Forward = 3
    Irrelevant = 4
    Deleted = 5
    Forward Reply = 6
    Draft = 7
    In Process = 8
    Scheduled = 9
    Follow Up = 10
    Automated = 11
    Sent = 13
    Archive = 14
    Pending = 15

    Tags Types

    Tag = 1
    Goal = 2
    Miss = 3
    Support Tag = 4
    Intents = 100
    Customer Satisfaction = 101
    SLA = 102
    Customer Satisfaction Open Answer = 103


    Was this article helpful?