Stackby Integration
Connect your Stackby stacks to create beautiful, embeddable widgets.
Connecting Stackby
Click Connect Stackby
From the connection modal, click Connect Stackby. If you’ve connected before, you can select a previous connection from the dropdown.
Enter your API key
Paste your Stackby API key. You can find this in your Stackby account under Account Settings.
Your API key is stored securely and is only used to read data from your Stackby account.
Choose your setup method
You have two options:
- Start Fresh - Create a new stack with sample data in your workspace. Perfect for trying out templates.
- Use existing data - Connect to a stack and table you’ve already set up in Stackby.
Select your data
If using existing data:
- Select a Workspace
- Select a Stack
- Select a Table
- Select a View (optional)
Done!
Your Stackby data is now connected and ready to display in your widget.
Finding your API Key
- Log in to Stackby
- Click your profile icon in the top-right corner
- Go to Account Settings
- Find your API key and copy it
Keep your API key private. Never share it publicly or commit it to version control.
Start Fresh vs Use Existing Data
Start Fresh
Best for:
- Trying out a template quickly
- Learning how Shareables works
- Creating a demo widget
When you choose “Start Fresh”, we’ll:
- Create a new stack in your selected workspace
- Add a table with the fields needed for the template
- Populate it with sample records you can customise
Use Existing Data
Best for:
- Displaying your real data
- Connecting to an established workflow
- Production widgets
Managing Multiple Connections
You can add multiple Stackby API keys:
- Switch connections - Use the dropdown to select a different connected account
- Add new connection - Click “Connect new account” to add another API key
How Data Refreshes
Your published widget uses smart caching to balance performance with data freshness.
How it works
- When a visitor loads your widget, they see the cached version for fast loading
- In the background, a request checks for updated data from your data source
- If new data is found, the cache is refreshed
- The next visitor (or page refresh) will see the updated data
Cache refresh rate
The cache refreshes at most once per minute, even if multiple visitors are loading your widget. This prevents excessive requests to your data source while ensuring updates appear quickly.
Forcing a refresh
Republishing your widget will immediately clear the cache, so the next visitor sees the latest data.
Troubleshooting
Invalid API key
Double-check that you’ve copied the full API key from your Stackby account settings. Make sure there are no extra spaces before or after the key.
No workspaces found
Make sure your API key has access to at least one workspace. If you recently created your Stackby account, try creating a workspace first.
No stacks found
Check that you have at least one stack in the selected workspace. Create a stack in Stackby first, then try connecting again.
Table or view not appearing
Check that your stack contains tables. If you just created a new stack, you may need to add a table in Stackby before it appears.
Failed to fetch data
Check your internet connection and try again. If the issue persists, get in touch.