Integration docs
Get an integration
Setup metadata for one integration: env var names, the field schema, the OAuth scope catalog, and the setup guide.
GET
https://cloud.generalinput.com/v1/integrations/:serviceAuthenticationRequires
docs:read on a platform API key. A CLI session always passes.Everything needed to walk a person through connecting the service, or to know what a credential of it will look like once connected.
Path parameters
| Name | Notes |
|---|---|
service | The slug from list integrations. |
Response
{
"service": "slack",
"title": "Slack",
"description": "Send messages, react to events, and read history.",
"credentialType": "oauth2",
"envVars": ["SLACK_ACCESS_TOKEN", "SLACK_BOT_TOKEN"],
"fields": [{ "name": "accessToken", "isSecret": true }],
"oauthScopes": [
{ "name": "chat:write", "description": "Send messages as the user." }
],
"setupGuide": "## Connecting Slack\n\n1. …"
}| Field | Type | Notes |
|---|---|---|
envVars | string[] | Env var names a credential of this service injects. Real credentials add an _<id> suffix; see list credentials. Empty for platform and noAuth. |
fields | object[] | Per-field name and isSecret from the credential schema. Empty for OAuth services without a declared schema. |
oauthScopes | object[], null | The scope catalog for oauth2 services that document one. null otherwise. |
setupGuide | string, null | Operator-facing markdown, when authored. |
Errors
| Status | When |
|---|---|
404 | No integration with that slug. |