connectors

Creates, updates, deletes, gets or lists a connectors resource.

Overview

Name	connectors
Type	Resource
Id	vercel.connect.connectors

Fields

The following fields are returned by SELECT queries:

get

The connector.

Name	Datatype	Description
id	string	Stable scl_ connector ID. Use this value directly in {connector}.
name	string	Connector name within the owning team.
default_installation_id	string	Installation used when a token request does not specify an installation. (wire: defaultInstallationId)
display_name	string	Human-readable connector name. (wire: displayName)
type_name	string	Human-readable name of the connector type. (wire: typeName)
accent_color	string	Hex accent color (e.g., #000000) for branding. (wire: accentColor)
app_tokens	object	App-token capabilities and known grants for the connector. (wire: appTokens)
background_color	string	Hex background color (e.g., #000000) for branding. (wire: backgroundColor)
client_url	string	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. (wire: clientUrl)
connection_method	string	The connection method this connector was created from, when the create request named one. (wire: connectionMethod)
created_at	number	Creation time in epoch milliseconds. (wire: createdAt)
created_by	object	Principal that created the connector. (wire: createdBy)
creation_mode	string	How the connector row was originally created. New create paths stamp this explicitly; older rows may omit it. (managed, manual) (wire: creationMode)
devsite	string	Developer website for the connected service.
docsite	string	Developer documentation for the connected service.
events	array	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.
icon	string	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}.
managed	object	Managed connector metadata exposed without leaking the manager connector or installation identifiers.
redirect_uri	string	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. (wire: redirectUri)
reinstall_at	number	Time when this connector started requiring reinstallation because an installation-affecting app-token grant changed. (wire: reinstallAt)
service	string	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.
supported_subject_types	array	Token subject types supported by the connector. (wire: supportedSubjectTypes)
supports_icon		Whether the connector icon can propagate to the provider. (false, maybe, true) (wire: supportsIcon)
supports_installation	boolean	Whether the connector supports an installation flow. (false, true) (wire: supportsInstallation)
supports_revocation	boolean	Whether Connect can revoke tokens for this connector. (false, true) (wire: supportsRevocation)
supports_triggers	boolean	Whether this connector type supports trigger webhooks. Derived from the type definition; indicates that triggers and triggerDestinations may be meaningful for this connector. (false, true) (wire: supportsTriggers)
target	string	Which of the service's products/surfaces this connector points at.
trigger_destinations	array	Destinations that incoming triggers should be forwarded to. Limited to 3 entries. Set the initial destination with triggerDestination during creation. Replace the complete set with PATCH /v1/connect/connectors/{connector}/trigger-destinations. (wire: triggerDestinations)
triggers	object	Incoming trigger configuration for the connector.
type	string	Connector implementation type. (api-key, aws-alpha, custom, discord, github, linear, linq, microsoft-entra, microsoft-teams, oauth, photon, salesforce, sendblue, slack, snowflake, snowflake-wif)
type_icon	string	Icon identifier supplied by the connector type. (wire: typeIcon)
uid	string	Team-scoped UID. URL-encode this value before using it in {connector}.
updated_at	number	Last update time in epoch milliseconds. (wire: updatedAt)
updated_by	object	Principal that most recently updated the connector. (wire: updatedBy)
user_tokens	object	User-token capabilities and known grants for the connector. (wire: userTokens)
website	string	Public website for the connected service.

list

A page of connectors.

Name	Datatype	Description
id	string	Stable scl_ connector ID. Use this value directly in {connector}.
name	string	Connector name within the owning team.
default_installation_id	string	Installation used when a token request does not specify an installation. (wire: defaultInstallationId)
display_name	string	Human-readable connector name. (wire: displayName)
type_name	string	Human-readable name of the connector type. (wire: typeName)
accent_color	string	Hex accent color (e.g., #000000) for branding. (wire: accentColor)
app_tokens	object	App-token capabilities and known grants for the connector. (wire: appTokens)
background_color	string	Hex background color (e.g., #000000) for branding. (wire: backgroundColor)
client_url	string	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. (wire: clientUrl)
connection_method	string	The connection method this connector was created from, when the create request named one. (wire: connectionMethod)
created_at	number	Creation time in epoch milliseconds. (wire: createdAt)
created_by	object	Principal that created the connector. (wire: createdBy)
creation_mode	string	How the connector row was originally created. New create paths stamp this explicitly; older rows may omit it. (managed, manual) (wire: creationMode)
devsite	string	Developer website for the connected service.
docsite	string	Developer documentation for the connected service.
events	array	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.
icon	string	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}.
managed	object	Managed connector metadata exposed without leaking the manager connector or installation identifiers.
redirect_uri	string	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. (wire: redirectUri)
reinstall_at	number	Time when this connector started requiring reinstallation because an installation-affecting app-token grant changed. (wire: reinstallAt)
service	string	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.
supported_subject_types	array	Token subject types supported by the connector. (wire: supportedSubjectTypes)
supports_icon		Whether the connector icon can propagate to the provider. (false, maybe, true) (wire: supportsIcon)
supports_installation	boolean	Whether the connector supports an installation flow. (false, true) (wire: supportsInstallation)
supports_revocation	boolean	Whether Connect can revoke tokens for this connector. (false, true) (wire: supportsRevocation)
supports_triggers	boolean	Whether this connector type supports trigger webhooks. Derived from the type definition; indicates that triggers and triggerDestinations may be meaningful for this connector. (false, true) (wire: supportsTriggers)
target	string	Which of the service's products/surfaces this connector points at.
trigger_destinations	array	Destinations that incoming triggers should be forwarded to. Limited to 3 entries. Set the initial destination with triggerDestination during creation. Replace the complete set with PATCH /v1/connect/connectors/{connector}/trigger-destinations. (wire: triggerDestinations)
triggers	object	Incoming trigger configuration for the connector.
type	string	Connector implementation type. (api-key, aws-alpha, custom, discord, github, linear, linq, microsoft-entra, microsoft-teams, oauth, photon, salesforce, sendblue, slack, snowflake, snowflake-wif)
type_icon	string	Icon identifier supplied by the connector type. (wire: typeIcon)
uid	string	Team-scoped UID. URL-encode this value before using it in {connector}.
updated_at	number	Last update time in epoch milliseconds. (wire: updatedAt)
updated_by	object	Principal that most recently updated the connector. (wire: updatedBy)
user_tokens	object	User-token capabilities and known grants for the connector. (wire: userTokens)
website	string	Public website for the connected service.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	connector	team_id, slug	Get the connector by ID. Accepts a dashboard/team requester or a deployment's project OIDC token; project requesters may only read connectors linked to their project and environment.
list	select		limit, cursor, project_id, search, type, service, sort, team_id, slug	List connectors that belong to a team.
create	insert	data, type, service, connection_method	team_id, slug	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.
update	update	connector	team_id, slug	Update a connector and return the connector with any service-side update signals that the caller must handle.
delete	delete	connector	team_id, slug	Delete a connector, its project connections, and its installation records.
replace_trigger_destinations	exec	connector, destinations	teamId, slug	Replace the full set of destinations that receive trigger requests for a connector.
get_token	exec	connector		Get an access token for a connector identified by the path parameter and scoped to the requester.
create_authorization_request	exec	connector		Create an authorization request for a connector and return the URL and verifier details needed to complete the flow.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
connector	string
cursor	string	Cursor from pagination.next on the previous response.
limit	integer	Maximum number of connectors to return. Defaults to 20.
project_id	string	Return only connectors connected to this project. (wire: projectId)
search	string	Search connector names, UIDs, and services.
service	string	Comma-separated provider or service identifiers.
slug	string	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.
sort	string	Sort by name in ascending order, or by creation or update time in descending order.
teamId	string	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.
team_id	string	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. (wire: teamId)
type	string	Comma-separated connector types: slack, discord, github, linear, linq, salesforce, sendblue, snowflake, snowflake-wif, microsoft-entra, api-key, photon, oauth, or custom.

SELECT examples

get

Get the connector by ID. Accepts a dashboard/team requester or a deployment's project OIDC token; project requesters may only read connectors linked to their project and environment.

SELECT
id,
name,
default_installation_id,
display_name,
type_name,
accent_color,
app_tokens,
background_color,
client_url,
connection_method,
created_at,
created_by,
creation_mode,
devsite,
docsite,
events,
icon,
managed,
redirect_uri,
reinstall_at,
service,
supported_subject_types,
supports_icon,
supports_installation,
supports_revocation,
supports_triggers,
target,
trigger_destinations,
triggers,
type,
type_icon,
uid,
updated_at,
updated_by,
user_tokens,
website
FROM vercel.connect.connectors
WHERE connector = '{{ connector }}' -- required
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;

list

List connectors that belong to a team.

SELECT
id,
name,
default_installation_id,
display_name,
type_name,
accent_color,
app_tokens,
background_color,
client_url,
connection_method,
created_at,
created_by,
creation_mode,
devsite,
docsite,
events,
icon,
managed,
redirect_uri,
reinstall_at,
service,
supported_subject_types,
supports_icon,
supports_installation,
supports_revocation,
supports_triggers,
target,
trigger_destinations,
triggers,
type,
type_icon,
uid,
updated_at,
updated_by,
user_tokens,
website
FROM vercel.connect.connectors
WHERE limit = '{{ limit }}'
AND cursor = '{{ cursor }}'
AND project_id = '{{ project_id }}'
AND search = '{{ search }}'
AND type = '{{ type }}'
AND service = '{{ service }}'
AND sort = '{{ sort }}'
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;

INSERT examples

create

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.

INSERT INTO vercel.connect.connectors (
data,
icon,
background_color,
accent_color,
type,
service,
connection_method,
params,
target,
uid,
name,
project_id,
environments,
triggers,
trigger_destination,
events,
team_id,
slug
)
SELECT 
'{{ data }}' /* required */,
'{{ icon }}',
'{{ background_color }}',
'{{ accent_color }}',
'{{ type }}' /* required */,
'{{ service }}' /* required */,
'{{ connection_method }}' /* required */,
'{{ params }}',
'{{ target }}',
'{{ uid }}',
'{{ name }}',
'{{ project_id }}',
'{{ environments }}',
{{ triggers }},
'{{ trigger_destination }}',
'{{ events }}',
'{{ team_id }}',
'{{ slug }}'
RETURNING
id,
name,
default_installation_id,
display_name,
type_name,
accent_color,
app_tokens,
background_color,
client_url,
connection_method,
created_at,
created_by,
creation_mode,
devsite,
docsite,
events,
icon,
managed,
redirect_uri,
reinstall_at,
service,
supported_subject_types,
supports_icon,
supports_installation,
supports_revocation,
supports_triggers,
target,
trigger_destinations,
triggers,
type,
type_icon,
uid,
updated_at,
updated_by,
user_tokens,
website
;

Manifest

# Description fields are for documentation purposes
- name: connectors
props:
  - name: data
    description: |
      Provider configuration for the selected connector type or connection method.
    value:
      serverUrl: "{{ serverUrl }}"
      serverConfig:
        issuer: "{{ issuer }}"
        authorization_endpoint: "{{ authorization_endpoint }}"
        token_endpoint: "{{ token_endpoint }}"
        userinfo_endpoint: "{{ userinfo_endpoint }}"
        jwks_uri: "{{ jwks_uri }}"
        jwks:
          keys:
            - kty: "{{ kty }}"
              kid: "{{ kid }}"
              use: "{{ use }}"
              key_ops: "{{ key_ops }}"
              alg: "{{ alg }}"
        revocation_endpoint: "{{ revocation_endpoint }}"
        introspection_endpoint: "{{ introspection_endpoint }}"
        end_session_endpoint: "{{ end_session_endpoint }}"
        device_authorization_endpoint: "{{ device_authorization_endpoint }}"
        registration_endpoint: "{{ registration_endpoint }}"
        response_types_supported:
          - "{{ response_types_supported }}"
        token_endpoint_auth_methods_supported:
          - "{{ token_endpoint_auth_methods_supported }}"
        token_endpoint_auth_signing_alg_values_supported:
          - "{{ token_endpoint_auth_signing_alg_values_supported }}"
        scopes_supported:
          - "{{ scopes_supported }}"
        grant_types_supported:
          - "{{ grant_types_supported }}"
        response_modes_supported:
          - "{{ response_modes_supported }}"
        subject_types_supported:
          - "{{ subject_types_supported }}"
        id_token_signing_alg_values_supported:
          - "{{ id_token_signing_alg_values_supported }}"
        id_token_encryption_alg_values_supported:
          - "{{ id_token_encryption_alg_values_supported }}"
        id_token_encryption_enc_values_supported:
          - "{{ id_token_encryption_enc_values_supported }}"
        claim_types_supported:
          - "{{ claim_types_supported }}"
        claims_supported:
          - "{{ claims_supported }}"
        code_challenge_methods_supported:
          - "{{ code_challenge_methods_supported }}"
        prompt_values_supported:
          - "{{ prompt_values_supported }}"
        claims_parameter_supported: {{ claims_parameter_supported }}
        request_parameter_supported: {{ request_parameter_supported }}
        request_uri_parameter_supported: {{ request_uri_parameter_supported }}
        require_request_uri_registration: {{ require_request_uri_registration }}
        service_documentation: "{{ service_documentation }}"
        op_policy_uri: "{{ op_policy_uri }}"
        op_tos_uri: "{{ op_tos_uri }}"
        logo_uri: "{{ logo_uri }}"
        client_id_metadata_document_supported: {{ client_id_metadata_document_supported }}
        authorization_details_types_supported:
          - "{{ authorization_details_types_supported }}"
      clientId: "{{ clientId }}"
      clientName: "{{ clientName }}"
      clientSecret: "{{ clientSecret }}"
      tokenEndpointAuthMethod: "{{ tokenEndpointAuthMethod }}"
      responseType: "{{ responseType }}"
      pkceRequired: {{ pkceRequired }}
      codeChallengeMethod: "{{ codeChallengeMethod }}"
      userAuthorization:
        enabled: {{ enabled }}
        scopes:
          - "{{ scopes }}"
      refreshTokens:
        enabled: {{ enabled }}
      clientCredentials:
        enabled: {{ enabled }}
        scopes:
          - "{{ scopes }}"
      forwardedClaims:
        idToken:
          - "{{ idToken }}"
      defaultAudience: "{{ defaultAudience }}"
      defaultTokenExpiresIn: {{ defaultTokenExpiresIn }}
      authorizationUrlParams: "{{ authorizationUrlParams }}"
      jwtBearer:
        enabled: {{ enabled }}
        scopes:
          - "{{ scopes }}"
        sub: "{{ sub }}"
        iss: "{{ iss }}"
        aud: "{{ aud }}"
        additionalClaims: "{{ additionalClaims }}"
        ttl: {{ ttl }}
        useClientCredentials: {{ useClientCredentials }}
      clientAssertion:
        type: "{{ type }}"
        ttl: {{ ttl }}
        claims: "{{ claims }}"
      subjectType: "{{ subjectType }}"
      values:
        - value: "{{ value }}"
          scope: "{{ scope }}"
          expiresAt: {{ expiresAt }}
      serviceUrls:
        - "{{ serviceUrls }}"
      instructions: "{{ instructions }}"
      appId: {{ appId }}
      appSlug: "{{ appSlug }}"
      appName: "{{ appName }}"
      owner:
        type: "{{ type }}"
        id: {{ id }}
        slug: "{{ slug }}"
        name: "{{ name }}"
      privateKeyPem: "{{ privateKeyPem }}"
      webhookSecret: "{{ webhookSecret }}"
      extras: "{{ extras }}"
      appScopes:
        - "{{ appScopes }}"
      userScopes:
        - "{{ userScopes }}"
      ownerOrganization:
        id: "{{ id }}"
        slug: "{{ slug }}"
        name: "{{ name }}"
        logoUrl: "{{ logoUrl }}"
      application:
        id: "{{ id }}"
        clientId: "{{ clientId }}"
        name: "{{ name }}"
        description: "{{ description }}"
        developer: "{{ developer }}"
        developerUrl: "{{ developerUrl }}"
        imageUrl: "{{ imageUrl }}"
        redirectUris:
          - "{{ redirectUris }}"
        distribution: "{{ distribution }}"
        webhookResourceTypes:
          - "{{ webhookResourceTypes }}"
        webhookUrl: "{{ webhookUrl }}"
        webhookEnabled: {{ webhookEnabled }}
        createdAt: "{{ createdAt }}"
        updatedAt: "{{ updatedAt }}"
      apiToken: "{{ apiToken }}"
      phoneNumbers:
        - "{{ phoneNumbers }}"
      consumerKey: "{{ consumerKey }}"
      consumerSecret: "{{ consumerSecret }}"
      loginHost: "{{ loginHost }}"
      apiKeyId: "{{ apiKeyId }}"
      apiSecretKey: "{{ apiSecretKey }}"
      slackTeam:
        id: "{{ id }}"
        name: "{{ name }}"
        domain: "{{ domain }}"
      signingSecret: "{{ signingSecret }}"
      verificationToken: "{{ verificationToken }}"
      botScopes:
        - "{{ botScopes }}"
      slashCommands:
        - command: "{{ command }}"
          description: "{{ description }}"
          usageHint: "{{ usageHint }}"
          shouldEscape: {{ shouldEscape }}
      shortcuts:
        - type: "{{ type }}"
          name: "{{ name }}"
          callbackId: "{{ callbackId }}"
          description: "{{ description }}"
      accountIdentifier: "{{ accountIdentifier }}"
      defaultSessionRole: "{{ defaultSessionRole }}"
      projectId: "{{ projectId }}"
      projectSecret: "{{ projectSecret }}"
  - name: icon
    value: "{{ icon }}"
    description: |
      SHA-1 digest of a PNG or JPEG icon that is at least 640 by 640 pixels. This field does not accept a URL or image bytes.
      First compute the digest and upload the raw image with [POST /v2/files](https://vercel.com/docs/rest-api/deployments/upload-deployment-files). Send `Content-Length` and the same 40-character digest in `x-vercel-digest`. Then set `icon` to that digest.
      ```js
      import { createHash } from 'node:crypto';
      import { readFile } from 'node:fs/promises';
      const VERCEL_TOKEN = process.env.VERCEL_TOKEN;
      const connectorId = 'scl_...';
      const bytes = await readFile('icon.png');
      const digest = createHash('sha1').update(bytes).digest('hex');
      await fetch('https://api.vercel.com/v2/files', {
      method: 'POST',
      headers: {
      Authorization: `Bearer ${VERCEL_TOKEN}`,
      'Content-Type': 'application/octet-stream',
      'Content-Length': String(bytes.length),
      'x-vercel-digest': digest,
      },
      body: bytes,
      });
      await fetch(`https://api.vercel.com/v2/connect/connectors/${connectorId}`, {
      method: 'PATCH',
      headers: {
      Authorization: `Bearer ${VERCEL_TOKEN}`,
      'Content-Type': 'application/json',
      },
      body: JSON.stringify({ icon: digest }),
      });
      ```
  - name: background_color
    value: "{{ background_color }}"
    description: |
      Branding background color (6-digit hex, for example
  - name: accent_color
    value: "{{ accent_color }}"
    description: |
      Branding accent color (6-digit hex, for example
  - name: type
    value: "{{ type }}"
    description: |
      Connector implementation type for full configuration. Known types: api-key, discord, github, linear, linq, microsoft-entra, oauth, photon, salesforce, sendblue, slack, snowflake, snowflake-wif. Optional when service and connectionMethod select the type.
  - name: service
    value: "{{ service }}"
    description: |
      Service slug or URL for which the connector is used. Required when connectionMethod is set. Service alone does not enable preset configuration.
  - name: connection_method
    value: "{{ connection_method }}"
    description: |
      Connection method slug of the service. Use it with service to select preset configuration.
  - name: params
    value: "{{ params }}"
    description: |
      Values for the selected connection method's template fields. Requires connectionMethod.
  - name: target
    value: "{{ target }}"
    description: |
      Which of the service's targets this connector is for. Requires "connectionMethod" and must be one that method serves. Optional.
  - name: uid
    value: "{{ uid }}"
    description: |
      Optional team-scoped unique identifier for the connector. If omitted or empty, Connect generates a value.
  - name: name
    value: "{{ name }}"
    description: |
      Connector name. The value is trimmed and cannot contain control characters. If omitted or empty, the project name is used. A name or projectId is required. API key connectors require name.
  - name: project_id
    value: "{{ project_id }}"
    description: |
      Project to connect during creation. If environments is omitted, the connection uses development, preview, and production.
  - name: environments
    value: "{{ environments }}"
    description: |
      Environments for the project connection. Requires projectId. Use one or more built-in environment names or stable custom environment IDs that belong to the project. Duplicate values are accepted and removed.
  - name: triggers
    value: {{ triggers }}
    description: |
      Whether the triggers are enabled for this connector.
  - name: trigger_destination
    description: |
      Initial trigger destination. Requires triggers to be enabled and a projectId here or at the top level. Connector responses expose the resulting set as triggerDestinations. Replace the complete set with PATCH /v1/connect/connectors/{connector}/trigger-destinations.
    value:
      projectId: "{{ projectId }}"
      path: "{{ path }}"
      branch: "{{ branch }}"
      customEnvironmentId: "{{ customEnvironmentId }}"
  - name: events
    value:
      - "{{ events }}"
    description: |
      Default trigger events for this connector.
  - name: team_id
    value: "{{ team_id }}"
    description: 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.
    description: 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.
  - name: slug
    value: "{{ slug }}"
    description: 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.
    description: 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.

UPDATE examples

update

Update a connector and return the connector with any service-side update signals that the caller must handle.

UPDATE vercel.connect.connectors
SET 
triggers = {{ triggers }},
events = '{{ events }}',
data = '{{ data }}',
icon = '{{ icon }}',
background_color = '{{ background_color }}',
accent_color = '{{ accent_color }}',
uid = '{{ uid }}',
name = '{{ name }}'
WHERE 
connector = '{{ connector }}' --required
AND team_id = '{{ team_id}}'
AND slug = '{{ slug}}'
RETURNING
connector,
reconsent_needed,
reinstall_needed,
service_sync;

DELETE examples

delete

Delete a connector, its project connections, and its installation records.

DELETE FROM vercel.connect.connectors
WHERE connector = '{{ connector }}' --required
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

replace_trigger_destinations

Replace the full set of destinations that receive trigger requests for a connector.

EXEC vercel.connect.connectors.replace_trigger_destinations 
@connector='{{ connector }}' --required, 
@teamId='{{ teamId }}', 
@slug='{{ slug }}' 
@@json=
'{
"destinations": "{{ destinations }}"
}'
;

get_token

Get an access token for a connector identified by the path parameter and scoped to the requester.

EXEC vercel.connect.connectors.get_token 
@connector='{{ connector }}' --required 
@@json=
'{
"subject": "{{ subject }}", 
"installationId": "{{ installationId }}", 
"audience": "{{ audience }}", 
"scopes": "{{ scopes }}", 
"resources": "{{ resources }}", 
"authorizationDetails": "{{ authorizationDetails }}", 
"validityBufferMs": {{ validityBufferMs }}
}'
;

create_authorization_request

Create an authorization request for a connector and return the URL and verifier details needed to complete the flow.

EXEC vercel.connect.connectors.create_authorization_request 
@connector='{{ connector }}' --required 
@@json=
'{
"subject": "{{ subject }}", 
"installationId": "{{ installationId }}", 
"audience": "{{ audience }}", 
"scopes": "{{ scopes }}", 
"resources": "{{ resources }}", 
"authorizationDetails": "{{ authorizationDetails }}", 
"validityBufferMs": {{ validityBufferMs }}, 
"returnUrl": "{{ returnUrl }}", 
"webhook": "{{ webhook }}", 
"prompt": "{{ prompt }}", 
"deviceCode": {{ deviceCode }}, 
"expiresInMs": {{ expiresInMs }}, 
"additionalParams": "{{ additionalParams }}"
}'
;