Sidebar
Configure dynamic store-driven UI blocks to render on your frontend.
Sidebar modules showcase additional information from the store. Modules are enabled in the store's configuration/The following modules are supported:
top_customer
Shows the top customer of the store.
textbox
Renders custom HTML on the sidebar
recent_payments
Shows information of most recent payor
featured_package
Showcases a particular package
giftcard_balance
Shows the user's giftcard balance
server_status
Online status of a store's server
payment_goal
Progress to completing a payment goal
community_goal
Progress to completing a community goal
Use the following endpoint to get all enabled sidebar module data:
Retrieves the available sidebar modules configured for the store.
The webstore identifier.
some-uuid
Successful response.
GET /api/accounts/{token}/sidebar HTTP/1.1
Host: headless.tebex.io
Accept: */*
Successful response.
{
"data": [
{
"id": 1,
"type": null,
"start_time": "2025-10-04T12:37:59.844Z",
"end_time": null,
"data": {
"header": "Top Customer",
"username": "Test",
"username_id": "d8d5a9237b2043d8883b1150148d6955",
"total": 1
}
}
]
}
Module Schemas
Last updated
Was this helpful?