1. Feedback Actions
  2. Update From Webchat

Feedback Actions

Update From Webchat Feedback Action

A feedback action called by the webchat system when a Webchat message is received.

Overview

When a Webchat message is received by the Stubber Platform the stubsession is derived to intelligently route the message to the correct stub.
Then the _update_from_webchat feedback action is triggered on the stub.

The _update_from_webchat feedback action is used to then further automate anything in the stub that needs to be done when a webchat message is received.

The message body of the Webchat message will be set to the message of the stubpost. i.e. stubpost.message.
All the details of the Webchat message will be available in the stubpost.data._incoming_webchat_data data path.

Data Structure

Feedback Action Data

Example data that is passed to the _update_from_webchat feedback action:

        "_incoming_webchat_data": {
  "sessionuuid": "d1b467d4-7eb6-448d-b21f-50578ebaf69b",
  "webchat_message": {
    "type": "text",
    "value": "hi"
  },
  "webchat_attachments": [
    {
      "contentType": "audio/webm",
      "filename": "voicenote_10:55_26_03_2025.webm",
      "fileuuid": "1825610a-d7c6-5e01-9934-0c92cbc20351",
      "originalname": "voicenote_10:55_26_03_2025.webm"
    }
  ],
  "webchat_configuration": {
    "branch": "draft",
    "pass_through_data": "{'some','data'}",
    "profile_uuid": "8e74e2f4-f88f-502d-a11f-d53ae932c3ec"
  },
  "webchat_meta_data": {
    "ip": "45.221.223.164",
    "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/134.0.0.0 Safari/537.36"
  },
  "webchat_profile": {
    "webchat_client_config": {
      "opening_message": {
        "type": "text",
        "value": "Initial message from DRAFT context"
      }
    }
  }
}

JSONSchema

The JSONSchema of the stubpost.data._incoming_webchat_data is:

        {
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Incoming Webchat Data",
  "type": "object",
  "properties": {
    "_incoming_webchat_data": {
      "type": "object",
      "properties": {
        "sessionuuid": {
          "type": "string",
          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
          "description": "UUID of the webchat session."
        },
        "webchat_message": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": ["text", "image", "audio", "file"],
              "description": "The type of the webchat message."
            },
            "value": {
              "type": "string",
              "description": "The text content of the message."
            }
          },
          "required": ["type", "value"],
          "additionalProperties": false
        },
        "webchat_attachments": {
          "type": "array",
          "description": "List of attachments included in the webchat message.",
          "items": {
            "type": "object",
            "properties": {
              "filename": {
                "type": "string",
                "description": "The name of the file."
              },
              "originalname": {
                "type": "string",
                "description": "The original name of the file as uploaded."
              },
              "fileuuid": {
                "type": "string",
                "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
                "description": "UUID of the file."
              },
              "contentType": {
                "type": "string",
                "description": "The MIME type of the file."
              }
            },
            "required": ["filename", "originalname", "fileuuid", "contentType"],
            "additionalProperties": false
          }
        },
        "webchat_configuration": {
          "type": "object",
          "properties": {
            "branch": {
              "type": "string",
              "description": "The branch of the webchat configuration."
            },
            "pass_through_data": {
              "type": "string",
              "description": "Additional data passed to the webchat configuration."
            },
            "profile_uuid": {
              "type": "string",
              "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
              "description": "UUID of the profile."
            }
          },
          "required": ["branch", "profile_uuid"],
          "additionalProperties": false
        },
        "webchat_meta_data": {
          "type": "object",
          "properties": {
            "ip": {
              "type": "string",
              "description": "IP address of the user."
            },
            "user_agent": {
              "type": "string",
              "description": "User agent of the browser or device used."
            }
          },
          "required": ["ip", "user_agent"],
          "additionalProperties": false
        },
        "webchat_profile": {
          "type": "object",
          "properties": {
            "webchat_client_config": {
              "type": "object",
              "properties": {
                "opening_message": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string",
                      "enum": ["text"],
                      "description": "The type of the opening message."
                    },
                    "value": {
                      "type": "string",
                      "description": "The text content of the opening message."
                    }
                  },
                  "required": ["type", "value"],
                  "additionalProperties": false
                }
              },
              "required": ["opening_message"],
              "additionalProperties": false
            }
          },
          "required": ["webchat_client_config"],
          "additionalProperties": false
        }
      },
      "required": ["sessionuuid", "webchat_message", "webchat_configuration", "webchat_meta_data", "webchat_profile"],
      "additionalProperties": false
    }
  },
  "required": ["_incoming_webchat_data"],
  "additionalProperties": false
}
Previous <- Update From Whatsapp
Next Update From Facebook Messenger ->