DocumentationManaging Connections

Managing Connections

4 minLast updated: 2026-03-31

What Are Connections?

Connections are named, reusable API endpoint configurations. Instead of entering URL, headers, and auth details every time you configure a workflow step, you create a Connection once and reference it by name.

Creating a Connection

Go to Dashboard → Connections and click "New Connection":

POST /api/v1/connections
{
  "name": "Inventory API",
  "url": "https://api.warehouse.com/v2",
  "auth_type": "bearer",
  "auth_config": {
    "token": "your-api-token"
  },
  "headers": {
    "Content-Type": "application/json"
  }
}

Authentication Types

  • bearer: Bearer token in Authorization header
  • basic: Basic auth with username and password
  • api_key: API key in a custom header (e.g., X-API-Key)
  • none: No authentication

Testing a Connection

Click "Test" on any connection to send a test request and verify it works. The test result shows: status code, response time, and response body preview. Connection status updates to active, error, or unreachable.

Managing Connections

GET    /api/v1/connections         - List all connections
POST   /api/v1/connections         - Create connection
GET    /api/v1/connections/:id     - Get connection details
PUT    /api/v1/connections/:id     - Update connection
DELETE /api/v1/connections/:id     - Delete connection
POST   /api/v1/connections/:id/test: Test connection

Was this article helpful?