Widget Resource (since 1.0.9)¶

A widget is an interface component either part of Speakap or of a third party application. Widgets can be found on the right side of the network and/or group timelines. Widgets are optional and can be turned on or off, through the network settings menu, by network administrators. They are also able to change the order in which the different widgets appear.

Changelog¶

1.1.10

Add type property.
Changed type to widgetType (following convention).

Since¶

1.0.9

Endpoints¶

Representations¶

JSON¶

Properties¶

Name \| Type		Description
appEID	EID	Required for type `app`, which app installed this widget.
type	string	“widget”
visible	boolean	Whether or not the widget is visible in the networktimeline
widgetType	string	`'spotlight'`, `'upgrade'`, `'coming_soon'`, `'mobile_clients'` or `'app'`

Example¶

{
    "_links": {
        "self": {
            "href": "https://api.speakap.io/networks/FEDCBA0987654321/widgets/"
        }
    },
    "widgets": [
        {
            "visible": true,
            "widgetType": "spotlight"
        },
        {
            "visible": true,
            "widgetType": "coming_soon"
        },
        {
            "visible": true,
            "widgetType": "mobile_clients"
        },
        {
            "appEID": "1234567890ABCDEF",
            "visible": true,
            "widgetType": "app"
        }
    ]
}