SnozeDevelopers
API referenceIntegrations

Start an OAuth install for a provider

Begins a provider install and returns the provider authorization URL, the opaque `state` token to echo back, and the expiry after which the attempt is void; the browser completes the flow at the provider and Snoze exchanges the code on the separate callback route, so no secret ever passes through this endpoint. Requires the `integrations:write` workspace permission. Fails when the provider is unknown, when the provider feature is disabled for the workspace, when the provider is manual-setup only, or when the deployment is missing the configuration that provider requires. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.

POST
/v1/workspaces/{workspaceId}/integrations/providers/{provider}/install
AuthorizationBearer <token>

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

In: header

Path Parameters

workspaceId*string
provider*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

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"  }}