Sign in
connect

Create a connector

Create a connector and optionally link it to a project. Use type with complete provider data, or use service with connectionMethod so Connect can supply the type, endpoints, templates, and defaults.

post/v1/connect/connectors

Query parameters

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

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.

slugstring
Example:my-team-url-slug

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

OR

Response

The connector was created.

idstring required

Stable scl_ connector ID. Use this value directly in {connector}.

uidstring required

Team-scoped UID. URL-encode this value before using it in {connector}.

defaultInstallationIdstring

Installation used when a token request does not specify an installation.

createdAtnumber required

Creation time in epoch milliseconds.

updatedAtnumber required

Last update time in epoch milliseconds.

reinstallAtnumber

Time when this connector started requiring reinstallation because an installation-affecting app-token grant changed.

creationMode'managed' | 'manual'

How the connector row was originally created. New create paths stamp this explicitly; older rows may omit it.

type'api-key' | 'custom' | 'discord' | 'github' | 'linear' | 'linq' | 'microsoft-entra' | 'microsoft-teams' | 'oauth' | 'photon' | 'salesforce' | 'sendblue' | 'slack' | 'snowflake' | 'snowflake-wif' required

Connector implementation type.

servicestring required

Best-effort identifier of the third-party service this connector represents, independent of type. Examples: 'slack', 'mcp.linear.app', and 'auth.example.com'. Always present in API responses.

connectionMethodstring

The connection method this connector was created from, when the create request named one.

targetstring

Which of the service's products/surfaces this connector points at.

namestring required

Connector name within the owning team.

displayNamestring required

Human-readable connector name.

clientUrlstring nullable

Provider-side URL for viewing or managing the resource represented by the connector. The destination can be an app, account, phone line, or service instance, depending on the connector type.

redirectUristring

Redirect URI registered with the third-party service for this connector, if any. Used by startAuthorization/startInstallation to replay the exact URI back to the provider's token endpoint. Absent on connectors created before this field was introduced; those callers fall back to the https://connect.vercel.com/callback default.

typeNamestring required

Human-readable name of the connector type.

typeIconstring

Icon identifier supplied by the connector type.

websitestring

Public website for the connected service.

devsitestring

Developer website for the connected service.

docsitestring

Developer documentation for the connected service.

iconstring

Connector branding icon. SHA-1 hash that resolves to the uploaded icon through the Vercel avatar service. Consumers render this with https://vercel.com/api/www/avatar/{icon}.

backgroundColorstring

Hex background color (e.g., #000000) for branding.

accentColorstring

Hex accent color (e.g., #000000) for branding.

supportedSubjectTypesstring[] required

Token subject types supported by the connector.

supportsInstallationfalse | true required

Whether the connector supports an installation flow.

supportsRevocationfalse | true required

Whether Connect can revoke tokens for this connector.

supportsTriggersfalse | true required

Whether this connector type supports trigger webhooks. Derived from the type definition; indicates that triggers and triggerDestinations may be meaningful for this connector.

{"stackTrail":"components:schemas:ConnectConnectorCreateResult:properties:supportsIcon","oasType":"schema","type":"unknown","description":"Whether the connector icon can propagate to the provider."}
eventsstring[]

Known events this connector subscribes to (e.g. Slack bot events, GitHub webhook events). Names are type-specific and validated by the managed-create flow when forwarded to the third-party service.

Changes