WidgetRestApi.post

descriptionstringnullable

What the widget shows, its business meaning and any caveats. Agents read it to understand the widget without loading its full configuration.

editorsinteger[]

A list of subject IDs (users, roles, or groups) that can alter the widget.

namestringrequired

The display name of the widget.

Possible values: non-empty and <= 250 characters

propsobject

The widget's type-specific values, as a JSON object.

schema_versioninteger

The version of the widget's schema that the props conform to.

Possible values: >= 1

Default value: 1

viewersinteger[]

A list of subject IDs (users, roles, or groups) that can view the widget.

widget_typestringrequired

The namespaced id of the registered widget this is an instance of.

Possible values: non-empty and <= 250 characters

WidgetRestApi.post

{
  "description": "string",
  "editors": [
    0
  ],
  "name": "string",
  "props": {},
  "schema_version": 1,
  "viewers": [
    0
  ],
  "widget_type": "string"
}