Skip to main content
Connect an integration when project work needs an external service or tool.

​
Steps

  1. Choose the service in the integration catalog.
  2. Connect OAuth when the service needs user or workspace authorization.
  3. For API key, basic auth, and client-credentials integrations, set the environment variables named in the integration’s setup guide (for example STRIPE_SECRET_KEY).
  4. For experimental integrations, set VERYFRONT_EXPERIMENTAL_INTEGRATIONS to all or to a comma-separated list of integration names.
  5. Enable the tools, channels, or storage surfaces the project needs.
  6. Test the integration from the project.
  7. Review access when project ownership changes.

​
Set credential environment variables

Credential-based integrations (API key, basic auth, client credentials) read their secrets from the project’s environment variables. The integration’s setup guide names the exact keys. Set variables per environment in Studio under the project’s environment settings, or with Create Environment Variable: POST /projects/{project_reference}/environment-variables?environment_id={environment_id}
Terminal
curl -X POST "https://api.veryfront.com/projects/my-project/environment-variables?environment_id=$ENVIRONMENT_ID" \
  -H "Authorization: Bearer $VERYFRONT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "key": "STRIPE_SECRET_KEY", "value": "sk_live_..." }'
For local development, put the same keys in the project’s .env file. See Configuration for how the framework reads them and Projects and configuration for environments.

​
Try it with REST

List available integrations: GET /integrations
Terminal
curl https://api.veryfront.com/integrations \
  -H "Authorization: Bearer $VERYFRONT_API_KEY"
List connected OAuth accounts: GET /integrations/user-connections
Terminal
curl https://api.veryfront.com/integrations/user-connections \
  -H "Authorization: Bearer $VERYFRONT_API_KEY"

​
API surfaces

SurfaceStart here
RESTIntegrations, Project Integrations, OAuth
GraphQLIntegrations, User OAuth Connected Integrations
MCPList Integrations, List User OAuth Integrations

​
Verify

Confirm the integration appears in the project. Run a small read-only tool call before using the integration in production work. Tools that change external state are marked as write tools; start with a read. If a credential-based integration fails, confirm the environment variable names match the integration’s setup guide exactly.

​
Integration surfaces

SurfaceUse it for
IntegrationService connected to a project.
OAuth connectionUser or workspace authorization.
ToolCallable action exposed by the service.
ChannelMessaging surface connected to project work.
External storageFiles managed outside Veryfront.

​
API reference

APIUse
RESTIntegrations, integration tools, OAuth, channels, and external storage.
GraphQLIntegration, OAuth, channel, and storage views.
MCPIntegration, OAuth, channel, and storage tools.