← Back to docs

Connections

Connections link SyncToScale to external systems like HRIS, payroll, messaging tools, and CRMs. They handle authentication and permissions so workflows can interact with other platforms securely.

POST Create or authorize a connection
GET Retrieve connection status

Creating a connection

Connections are created by specifying a provider and authentication type. OAuth-based providers will redirect users to authorize access.

POST /connections
{
  "provider": "slack",
  "auth_type": "oauth",
  "scopes": ["chat:write", "users:read"]
}

Checking connection status

Once created, you can query a connection to verify health and authorization status before running workflows.

GET /connections/{connection_id}
{
  "id": "conn_123",
  "provider": "slack",
  "status": "healthy",
  "last_validated": "2025-01-18T12:44:00Z"
}

Re-authentication

If a connection expires or permissions change, it may require re-authentication. SyncToScale will surface these states so workflows can be paused safely.