POST /v1/connect/connectors/{connector}/projects/{projectId}

Connect a connector to a project, or replace the environments on an existing project connection.

Servers

Path parameters

Name Type Required Description
projectId String Yes

Vercel project ID.

connector String Yes

Stable connector ID or URL-encoded team-scoped UID. Examples: scl_abc123 or slack%2Fmy-bot.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
teamId String No

The team ID that scopes the request. Do not send it with slug. If both are omitted, Vercel uses the team associated with the token or the authenticated user's default team. The request returns 401 if no team can be selected.

slug String No

The team slug that scopes the request. Do not send it with teamId. If both are omitted, Vercel uses the team associated with the token or the authenticated user's default team. The request returns 401 if no team can be selected.

Request body fields

Name Type Required Description
environments[] Array Yes

One or more built-in environment names or stable custom environment IDs that belong to the project. Duplicate values are accepted and removed.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.