1. Canvas Components
  2. Clear Canvas

Canvas Components

Clear Canvas

Explains clearing previously rendered hosted Webchat canvas components. Useful for resetting the UI between workflow steps or chat responses.

To remove the previously rendered component, send a notification to render "none".

Example Usage

        {
  "platforms": {
    "webchat": {
      "sessionuuid": "~~stub.data._incoming_webchat_data.sessionuuid",
      "webchat_control_event": {
        "action": "render_component",
        "params": {
          "component_type": "none",
          "component_params": {}
        }
      }
    }
  }
}

      

This action will clear any previously rendered component from the canvas and return it to its default state.