Vercel Connect Concepts

Vercel Connect is built around six primitives. Read these in order if you want a top-down picture; jump to a single page if you're debugging a specific behavior.

• Connectors: The team-owned record that represents one third-party service. Browse the connector catalog to see the available services.
• Installations: How one connector serves many tenants. One Slack connector, for example, can serve many workspaces.
• Tokens: The short-lived credentials your code requests from Vercel Connect. Covers subject types, scopes, resources, authorizationDetails, refresh, and revocation.
• Project links: How a connector is bound to one or more Vercel projects and which environments can request tokens.
• Triggers: Incoming webhooks from third-party services, verified by Vercel Connect and forwarded to your projects.
• Authentication: The two auth axes, namely who is calling Vercel Connect and how Vercel Connect proves identity to the provider.

A team creates a connector for a provider. That connector accepts installations from individual tenants (workspaces, organizations). The team links the connector to one or more Vercel projects, scoped to specific environments. At runtime, a deployment in a linked project requests a token from Vercel Connect; the token represents an authorized identity at the provider and is scoped by the parameters of the request. Some providers also push triggers (webhooks) back into Vercel Connect, which forwards them to the connector's registered destinations.

• Quickstart: Build the four pieces end to end in under ten minutes.
• SDK Reference: API reference for @vercel/connect.
• CLI Reference: API reference for vercel connect.