Integrations

Create an integration connection

Changed on

Create an integration connection for an api_key provider. Credentials are validated against the vendor, then stored encrypted.

post/integrations/connections

Request

  • Base URL: https://api.sazabi.com/v1
  • URL: https://api.sazabi.com/v1/integrations/connections
  • 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

Integration provider to connect. Must use api_key auth (see authType in the provider catalog).

displayNamestring

Optional display name for the connection.

credentialsobject required

Vendor credentials. Fields vary by provider (see credentialFields on the provider catalog). Validated against the vendor before the connection is created; never returned.

Response

OK

Changes

  • 6853a8959e9cRevision changes
    • warning

      added the new gitcafe enum value to the / response property for the response status

    • info

      added the new gitcafe enum value to the request property

  • 9be5c4da3dc5Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status