Start Install

Authorization

apiKey

AuthorizationBearer <token>

Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.

In: header

workspaceId*string

provider*string

application/json

TypeScript Definitions

Use the request body type in TypeScript.

label?string|null

key?string|null

manifest?|null

redirectTo?string|null

curl -X POST "https://example.com/v1/workspaces/string/integrations/providers/string/install" \  -H "Content-Type: application/json" \  -d '{}'

{  "data": {    "provider": "string",    "installKind": "github_app",    "url": "string",    "state": "string",    "expiresAt": "string"  }}

{  "_tag": "ApiNotFound",  "error": "not_found",  "message": "That item does not exist, or this key cannot see it.",  "status": 404}

{  "_tag": "ApiNotFound",  "error": "not_found",  "message": "That item does not exist, or this key cannot see it.",  "status": 404}