Skip to main content

Connect to a Tulip Table

Set up a data connection that pulls records from a Tulip table so your widgets can display that data.

Prerequisites:

  • An admin has created a Tulip data source config for your Tulip instance
  • You have access to that config (admins have access by default)

Steps​

1. Open Data Connections​

Go to Data Connections in the left sidebar and click New Connection.

2. Select Tulip​

Choose Tulip as the connection type.

3. Choose a data source config​

Select the Tulip instance you want to connect to from the dropdown. If you don't see any options, ask your admin to grant you access.

4. Select a table​

Pick the table you want to read from. The dropdown loads tables from your Tulip instance.

5. Choose fields​

Select the fields (columns) you want to include. You can select all fields or pick specific ones. Selecting only what you need keeps things faster and simpler.

6. Name the connection​

Enter a descriptive name, like "Production Orders" or "Inventory Levels". This name is what you'll use in widget code:

const data = await getData("Production Orders");

7. (Optional) Add filters​

If you only need a subset of records, click Add Filter and configure:

  • The field to filter on
  • The comparison (equals, contains, greater than, etc.)
  • The value to compare against

Add multiple filters if needed, and choose whether records must match all filters (AND) or any filter (OR).

8. (Optional) Configure caching​

Enable caching if you want faster repeated reads. The defaults (5-minute delta refresh, 48-hour full rebuild) work well for most cases. Adjust if your data changes very frequently or very rarely.

9. Save​

Click Save. Your connection is now available to any widget in your organization.

Verify it works​

  1. Go to Widgets and create a new widget (or open an existing one).
  2. In the Data tab, add your new connection.
  3. In the JavaScript tab, add: const data = await getData("Your Connection Name"); followed by console.log(data);.
  4. Check the Console tab. You should see an array of records from your Tulip table.

Troubleshooting​

  • No tables in the dropdown — The data source config may have incorrect credentials. Ask your admin to test the connection in Organization Settings.
  • Empty data returned — Check your filters. Try removing all filters to confirm the table has records.
  • "Config not accessible" error — Ask your admin to grant you access to the data source config.