Widgets API
Widgets
Widgets refer to any touchpoint that can be embedded onto a digital property that is made up of either an "In-Line" or possibly also an "Expanded Tile" view. This endpoint allows you to create widgets and returns an embed code.
Properties
| Field | Type | POST | PUT | Definition |
|---|---|---|---|---|
id | integer | X | X | Widget ID |
widget_type_id | integer | X | X | Widget type id |
stack_id | integer | X | X | Widget stack Id |
guid | string | X | X | 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 | X | X | The widget embed code |
gen | integer | X | X | Version of widget |
style_name | string | X | X | |
created | string | X | X | ISO Date Time string |
modified | string | X | X | ISO Date Time string |
created_at | timestamp | X | X | Moderationview's creation time |
updated_at | timestamp | X | X | Moderationview's modification time |
style properties
style propertiesWidget style:
config properties
config propertiesGET widgets
Retrieves all widget available in the Stack.
Resource URL
https://api.stackla.com/api/widgets
Resource Details
Rate limited: Yes
Access scope: User
Request Parameters
No additional request parameters are available.
POST widgets
Creates a new widget in the Stack.
Resource URL
https://api.stackla.com/api/widgets
Resource Details
Rate limited: Yes
Access scope: User
Request Parameters
No additional request parameters are available.
GET widgets/:widgetId
Retrieves a specific widget available in the Stack by its ID.
Resource URL
https://api.stackla.com/api/widgets/:widgetId
Resource Details
Rate limited: Yes
Access scope: User
Request Parameters
| Name | Mandatory | Request type | Description |
|---|---|---|---|
widgetId | Yes | endpoint | ID of the widget |
PUT widgets/:widgetId
Updates a specific widget available in the Stack by its ID.
Resource URL
https://api.stackla.com/api/widgets/:widgetId
Resource Details
Rate limited: Yes
Access scope: User
Request Parameters
| Name | Mandatory | Request type | Description |
|---|---|---|---|
widgetId | Yes | endpoint | ID of the widget |
DELETE widgets/:widgetId
Deletes a specific widget available in the Stack by its ID.
Resource URL
https://api.stackla.com/api/widgets/:widgetId
Resource Details
Rate limited: Yes
Access scope: User
Request Parameters
| Name | Mandatory | Request type | Description |
|---|---|---|---|
widgetId | Yes | endpoint | ID of the widget |