Sign in

v14

latestOpenAPI 3.0.32026-08-04377889.4 MB
connect

Create a connector

Create a connector from type-specific configuration and optionally link it to a project during creation.

post/v1/connect/connectors

Request body

iconstring
backgroundColorstring
accentColorstring
typestring

Known types: api-key, github, linear, oauth, photon, salesforce, slack, snowflake. Optional when "connectionMethod" is set.

servicestring

Service slug or URL for which the connector is used.

connectionMethodstring

Connection method slug of the service.

paramsobject

Values for the connection method's templateFields.

targetstring

Which of the service's targets this connector is for. Requires "connectionMethod" and must be one that method serves. Optional.

uidstring
namestring
projectIdstring

Link to the specified project when specified. See environments.

triggersboolean

Whether the triggers are enabled for this connector.

eventsstring[]

The list of the defaults trigger events for this connector.

Response

idstring required
ownerIdstring required
createdAtnumber required
updatedAtnumber required
deletedAtnumber
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.

publicfalse | true required
uidstring required
type'api-key' | 'custom' | 'discord' | 'github' | 'linear' | 'microsoft-entra' | 'oauth' | 'photon' | 'salesforce' | 'slack' | 'snowflake' | 'snowflake-wif' required
servicestring required

Best-effort identifier of the third-party service this client represents, independent of type. Examples: 'slack', 'mcp.linear.app', 'auth.example.com'. Always non-empty on the API response — falls back through storedClient.service ?? typeDef.service ?? typeDef.type.

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
clientUrlstring nullable
redirectUristring

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

defaultInstallationIdstring
dataobject required
typeNamestring required
typeIconstring
websitestring
devsitestring
docsitestring
iconstring

Client branding icon. SHA-1 hash that resolves to the uploaded icon via the Vercel avatar service. Clients 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
supportsInstallationfalse | true required
supportsRevocationfalse | true required
ownerTenantIdstring
supportsTriggersfalse | true required

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

{"stackTrail":"paths:/v1/connect/connectors:post:responses:201:content:application/json:schema:properties:supportsIcon","oasType":"schema","type":"unknown"}
eventsstring[]

Known events this client 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.

isConnectedToPrioritizedProjectfalse | true

Whether this connector is linked to the project supplied through prioritizedProjectId. Only present on prioritized list responses.