Connections
A connection is your environment's settings for one connector, such as Gmail: its name and the OAuth client ID, client secret and scopes Scalekit uses to sign users in to the app. Users then link their own accounts to it as connected accounts. See Connections for setting one up in the dashboard.
Typical flow. Create a connection for a connector, register an OAuth app with the provider using the redirect_uri in the response, then update the connection with the app's client ID, client secret and the scopes you need.
| Method | Endpoint | Path | What it does | SDKs |
|---|---|---|---|---|
| POST | Create a connectionCreate a connection for a connector, such as Gmail. | / | Create a connection for a connector, such as Gmail. | PythonNode.js |
| GET | Get a connectionGet a connection and its settings, by the connection's name or ID. | / | Get a connection and its settings, by the connection's name or ID. | PythonNode.js |
| GET | List connectionsList connections, filtered by connector or name. | / | List connections, filtered by connector or name. | PythonNode.js |
| PATCH | Update a connectionRename a connection, or change its client ID, client secret and scopes. | / | Rename a connection, or change its client ID, client secret and scopes. | PythonNode.js |
| DELETE | Delete a connectionDelete a connection. | / | Delete a connection. | PythonNode.js |