HTTP API and custom connections

How to connect services and internal systems that don't have a dedicated connector, using an HTTP API

Even if a service isn't in the list of connectors, you can connect it with an HTTP API data source as long as it provides an API. Without waiting for a new connector to be added, you can analyze and visualize data from internal systems and SaaS tools just like any other data.

Connect with HTTP API

Choose HTTP API

Open Data sources > Add data source in the sidebar, then search for "HTTP API" and select it. The HTTP API settings open as a full page, not a dialog (click Back to return to the previous screen).

Set the endpoint and authentication

Under Choose an authentication method, choose the API's authentication method from the following:

No authentication
API key
Bearer token
Basic authentication
OAuth (client credentials)
OAuth (authorization code)

Then fill in the following fields:

Name (required) — The name shown in the data source list. You can change it later
Base URL (required) — The API's base URL. Requests can only be sent to paths under this URL
Headers — Use Add to specify any required request headers
Query parameters — Use Add to specify any required query parameters
Knowledge — Paste the URL of an OpenAPI definition, or the text of the API specification

When you're done, click Add.

If your data source limits access by IP address, add Squadbase's IP addresses to its allowlist. You can find them with Show IP addresses at the bottom of the form.

Use it in a project

A connected data source can be used from projects just like any other data source. In chat, ask something like "Get last month's order data from the ○○ API and show me the daily count."

The HTTP API settings page, with "Choose an authentication method" (No authentication, API key, Bearer token, Basic authentication, OAuth (client credentials), OAuth (authorization code)), the Name, Base URL, Headers, Query parameters, and Knowledge fields, the IP allowlist notice, and the "Add" button

What you need

The information you need differs by service. Check the API documentation of the service you want to connect for information such as:

The API's base URL
The authentication method (API key, Bearer token, Basic authentication, OAuth, and so on) and the values it requires
Any required request headers

Services that don't provide a public API can't be connected this way. Consider other options, such as exporting to CSV and importing it. Some APIs, such as those with non-standard authentication methods, also aren't supported by the HTTP API data source.