createWidget

POST

/api/v1/widgets

const url = 'https://example.com/api/v1/widgets';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"provider":"example","presetId":"leaderboard","name":"example","description":"example","configuration":{}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/v1/widgets \
  --header 'Content-Type: application/json' \
  --data '{ "provider": "example", "presetId": "leaderboard", "name": "example", "description": "example", "configuration": {} }'

Creates a reusable Widget or catalog App. An App recipe may atomically provision one hidden managed Data Source while preserving normal dependency and manifest behavior.

Request Body^required

application/json

object

provider

required

Closed renderable Widget or App identifier from the release-owned content-definition catalog.

string

/^[a-z][a-z0-9_-]{0,79}$/

presetId

string

nullable

Allowed values: leaderboard status_board queue_board schedule_departures opening_hours directory

name

required

string

>= 1 characters <= 180 characters

description

string

<= 2000 characters

configuration

required

Provider-specific configuration. Native text Widgets omit textScale for automatic bounds-first sizing or use 25–500 percent; contentPadding defaults to 10 percent per edge and accepts 0–40.

object

Responses

201

Widget created

422

Provider unknown, Data Source incompatible, or a selected field does not exist

createWidget

Request Bodyrequired

Responses

201

422

Request Body^required