Send Widget
Send a dynamic UI widget component to the chat. Takes widget data as input.Properties
| Property | Value |
|---|---|
| Type | send-widget |
| Family | Actions |
| Group | Utilities |
Parameters
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| componentId | Widget Component | Select | Select the widget component to render | Yes |
| widgetData | Widget Data | JSON | JSON data to populate the widget template. The schema depends on the selected component. | Yes |
| additionalInstructions | Additional Instructions | String | Optional text to display alongside the widget. This can be used to provide additional context, instructions, or prompts to the user viewing the widget. | No |
Outputs
| Name | Label | Type | Description |
|---|---|---|---|
| success | success | boolean | Whether the widget was sent successfully |
| componentId | componentId | string | ID of the rendered component |
| componentName | componentName | string | Name of the rendered component |
| widget | widget | object | The compiled widget data |
| userResponse | userResponse | object | User response data (if widget is interactive) |
| status | status | string | Status: widget_sent, user_responded, timeout, or cancelled |