Skip to Content
veriom

Start connector OAuth

Begin connecting a provider through its Veriom OAuth app; no secret is typed. A managed connector is installed; GitLab and Bitbucket become a repository connection; slack_webhook and discord_webhook become a Slack or Discord App.

POST
/v1/workspaces/{workspace_id}/connector-oauth/{definition_key}/start

Begin connecting a provider through its Veriom OAuth app; no secret is typed.

A managed connector is installed; GitLab and Bitbucket become a repository connection; slack_webhook and discord_webhook become a Slack or Discord App.

Authorization

workspaceToken
headerAuthorizationBearer <vat_<opaque-token>>

Expiring, hashed workspace token with explicit scopes.

Path Parameters

workspace_id*Workspace Id
Formatuuid
definition_key*Definition Key

Request Body

application/json
  1. body
account?|

Bitbucket only: the workspace slug to connect. Bitbucket no longer lists a person's workspaces across the account, so it is named once here. GitLab discovers every project the person can read.

config?

The connector's non-secret setup config, checked before the consent screen. Ignored when reconnecting, which keeps the installation's config.

connection_id?|

GitLab and Bitbucket: reconnect this repository connection, replacing its credential and keeping its repositories and their selection.

destination?|

slack_webhook and discord_webhook: the events, repository, branch and origin of the App to create. display_name names it; by default the provider and channel.

display_name?|

Defaults to the provider's name, numbered when it is already taken.

installation_id?|

Reconnect this Veriom OAuth app installation: its grant is replaced and its history kept. Omit to create a new installation.

next_path?Next Path

Where the browser lands after consent, with connector_status=connected and connector_installation_id (repository_connection_id and repositories_enabled for GitLab and Bitbucket), or connector_status=error and connector_reason.

Length1 <= length <= 500
Default"/onboarding"

Response Body

Successful Response

application/json
  1. response
authorization_url*Authorization Url

Send the browser here for the consent screen.

Example Request
curl -X POST 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/connector-oauth/string/start' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "authorization_url": "string"}