HTTP API
Connect any external HTTP API to DashX. Once installed, you can define Operations that call it, and use its responses anywhere in DashX.
Use this when a service you depend on has no dedicated DashX integration.
Prerequisites
Before setting up the HTTP API integration, ensure you have:
- An active DashX account
- The base URL of the API you want to call
- Whatever credentials that API requires
Connect to DashX
- Log in to your DashX workspace
- Navigate to Settings > Integrations
- Click [+] to add a new integration and select HTTP API
- Choose the environments you want to enable it for
- Enter the configuration below and save
Configuration
| Field | Description |
|---|---|
| Base URL | The root URL every request is made against, e.g. https://api.example.com/v1. |
| Auth Strategy | How requests authenticate. The remaining fields depend on what you pick. |
Auth strategies
None
No credentials are sent. Use for public APIs.
Basic
HTTP Basic authentication.
| Field | Description |
|---|---|
| Username | Username sent in the Authorization header. |
| Password | Password sent in the Authorization header. |
Bearer Token
A static token sent as Authorization: Bearer <token>.
| Field | Description |
|---|---|
| Token | The bearer token. |
Oauth
OAuth 2.0. DashX obtains and refreshes access tokens for you.
| Field | Description |
|---|---|
| Client ID | OAuth client identifier. |
| Client Secret | OAuth client secret. |
| Access Token URL | Endpoint DashX exchanges credentials at for an access token. |
| Refresh Token URL | Endpoint DashX uses to refresh an expired access token. |
| Scope | Space-separated scopes to request. |
Define operations
With the integration installed, create an operation with the API Request behavior to call an endpoint. Parameters become the operation's GraphQL arguments, and a response mapper reshapes the payload into the form you want to expose. See Operations.
Related: the API Hub app.
Point each environment's installation at that environment's API — a sandbox base URL in development, production in production — so the same operation works everywhere without changes.