.png%3Falt%3Dmedia%26token%3D6deff902-b475-4b95-bffc-b313f43260b5)
.png%3Falt%3Dmedia%26token%3D6deff902-b475-4b95-bffc-b313f43260b5)
Widgets API Reference
The following documentation is for our Gen 2.0 widgets only. If you wish to receive information regarding Gen 1.0 widgets, please contact your CSM representative or log a ticket through support.
Our Widgets API is currently running on a Beta version, as such this documentation is a work in progress. If you come across any errors, have requests or suggestions please contact us.
Widgets refer to any Visual UGC Social Visual that can be embedded onto a digital property that is made up of either an "In-Line" and possibly also an "Expanded Tile" view. This endpoint allows you to create widgets and returns an embed code.
Field | Type | Value | POST | PUT | Definition |
|---|---|---|---|---|---|
id | integer | | | | Widget ID |
widget_type_id | integer | | | | Widget type id |
stack_id | integer | | | | Widget stack Id |
guid | string | | | | Widget GUID |
style | | | | Widget style config | |
config | | | | Widget config | |
filter_id | integer | | | | Content filter for widget |
enabled | boolean | | | | Enabled widget |
custom_css | string | | | | Custom css for inline tile |
lightbox_custom_css | string | | | | Custom css for lightbox |
custom_js | string | | | | Custom javascript for inline tile |
lightbox_custom_js | string | | | | Custom javascript for lightbox |
external_js | string | | | | URL of external js to inject to parent page |
embed_code | string | | | | The widget embed code |
gen | integer | | | | Version of widget |
style_name | string | | | | |
created | string | | | | ISO Date Time string |
modified | string | | | | ISO Date Time string |
created_at | timestamp | | | | Moderationview's creation time |
updated_at | timestamp | | | | Moderationview's modification time |
Widget style:
Retrieves all widget available in the Stack.
https://api.stackla.com/api/widgetsRate limited
Yes
Access scope
User
No additional request parameters are available.
Creates a new widget in the Stack.
https://api.stackla.com/api/widgetsRate limited
Yes
Access scope
User
No additional request parameters are available.
Retrieves a specific widget available in the Stack by its ID.
https://api.stackla.com/api/widgets/:widgetIdRate limited
Yes
Access scope
User
Name | Mandatory | Request type | Description |
|---|---|---|---|
widgetId | Yes | endpoint | |
ID of the widget | | | |
|
Updates a specific widget available in the Stack by its ID.
https://api.stackla.com/api/widgets/:widgetIdRate limited
Yes
Access scope
User
Name | Mandatory | Request type | Description |
|---|---|---|---|
widgetId | Yes | endpoint | |
ID of the widget | | | |
|
Deletes a specific widget available in the Stack by its ID.
https://api.stackla.com/api/widgets/:widgetIdRate limited
Yes
Access scope
User
Name | Mandatory | Request type | Description |
|---|---|---|---|
widgetId | Yes | endpoint | |
ID of the widget | | | |
|
Last modified 2mo ago