Integrations

Begin a browser connect flow

Changed on

Begin a browser connect flow for an OAuth or app-installation provider. Returns a vendor URL to open in a browser and an attempt to poll; the vendor exchange completes server-side and no token ever reaches the caller.

post/integrations/connect

Request

  • Base URL: https://api.sazabi.com/v1
  • URL: https://api.sazabi.com/v1/integrations/connect
  • Auth: none declared

Request body

organizationIdstring

Organization to connect in. Auto-filled from CLI and SDK context when omitted. User tokens must supply it unless the credential's fixed scope resolves it; secret keys may omit it (the key's organization applies).

provider'slack' | 'github' | 'linear' | 'pagerduty' | 'victorops' | 'rootly' | 'incident_io' | 'webhook' | 'teams' | 'bitbucket' | 'jira' | 'gitcafe' required

Browser-auth provider to connect (oauth or app_installation). Must report browserConnectSupported: true in the provider catalog.

displayNamestring

Optional display name for the resulting connection.

projectIdstring

Project the completed connection defaults its routing to. Must belong to the organization.

Response

OK

urlstring required

Vendor authorization (or app installation) URL to open in a browser signed into the Sazabi dashboard as the same user.

attemptIdstring uuid required

Connect attempt to poll via integrations.getConnectAttempt while the browser flow completes.

expiresAtstring date-time required

When the attempt expires if the browser flow never completes.

Changes