Skip to main content

Message response types

This page documents all response types supported in message:brain_received events. Each response includes an action_id that Moveo uses internally to track UI interactions and analytics.

Text​

{
  "type": "text",
  "text": string,
  "action_id": string,
  "options": [
    {
      "label": string,
      "text": string
    }
  ]
}

Image​

{
  "type": "image",
  "url": string,
  "name": string,
  "action_id": string
}

Video​

{
  "type": "video",
  "url": string,
  "name": string,
  "size": number,
  "action_id": string
}

File​

{
  "type": "file",
  "url": string,
  "name": string,
  "size": number,
  "action_id": string
}

URL​

{
  "type": "url",
  "url": string,
  "action_id": string
}
{
  "type": "carousel",
  "cards": [
    {
      "title": string,
      "subtitle": string,
      "media": {
        "type": string,
        "url": string
      },
      "buttons": [
        {
          "type": string,
          "label": string,
          "value": string,
          "url": string,
          "trigger_node_id": string,
          "height": string
        }
      ],
      "default_action": object
    }
  ],
  "action_id": string
}

Webview​

{
  "type": "webview",
  "url": string,
  "name": string,
  "label": string,
  "trigger_node_id": string,
  "height": string,
  "action_id": string
}

Survey​

Same schema as Webview, but with "type": "survey".

{
  "type": "survey",
  "url": string,
  "name": string,
  "label": string,
  "trigger_node_id": string,
  "height": string,
  "action_id": string
}

Pause​

{
  "type": "pause",
  "duration": number,
  "show_typing": boolean,
  "action_id": string
}

Handover​

{
  "type": "handover",
  "name": string,
  "action_id": string
}

Resolve (close)​

{
  "type": "close",
  "action_id": string
}

Refer to the message:brain_received section in WebSocket server events for the full structure including context, timestamp, and debug fields.

Last updated on