Generate OAuth URL for a workspace/tenant connection

Generate an OAuth URL that creates a workspace or tenant-level channel connection (Slack workspace install or MS Teams admin consent). The generated URL expires after 5 minutes.

Authorization

secretKey

Authorization<token>

API key authentication. Allowed headers-- "Authorization: ApiKey <secret_key>".

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

subscriberId?string

The subscriber ID to associate with the channel connection. For Slack: optional for workspace connections (required only for incoming-webhook scope). For MS Teams: optional. Admin consent is tenant-wide.

integrationIdentifier*string

Integration identifier

connectionIdentifier?string

Identifier of the channel connection that will be created. Generated automatically if not provided.

context?

scope?array<string>

Slack only: OAuth scopes to request during authorization. If not specified, default scopes will be used: chat:write, chat:write.public, channels:read, groups:read, users:read, users:read.email. MS Teams: ignored — uses admin consent with pre-configured Azure AD permissions.

connectionMode?string

Connection mode that determines how the channel connection is scoped. "subscriber" (default) associates the connection with a specific subscriber. "shared" associates the connection with a context instead of a subscriber.

Value in

"subscriber"
"shared"

autoLinkUser?boolean

When true (default when connectionMode is "subscriber"), after the workspace/tenant connection is created the OAuth flow also links the subscriber who clicked "Connect" as a personal endpoint. For Slack, uses the authed_user.id returned by oauth.v2.access — no extra redirect. For MS Teams, triggers a second OAuth redirect for delegated user-identity consent. Set to false to only create the workspace connection without linking the individual user.

Response Body

`application/json`

curl -X POST "https://example.com/v1/integrations/channel-connections/oauth" \  -H "Content-Type: application/json" \  -d '{    "integrationIdentifier": "string"  }'

{  "data": {    "url": "https://slack.com/oauth/v2/authorize?state=..."  }}

Generate OAuth URL for a workspace/tenant connection

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

404application/json

405application/json

409application/json

413application/json

414application/json

415application/json

422application/json

429application/json

500application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`