Edy documentation

Connect once. Build across your workspace.

Edy uses secure service authorization instead of asking you to copy secret keys. You approve access, choose the account or project, and keep control of the connection.

Getting started

One connection, four clear steps.

Connectors belong to your Edy workspace, not a single project. Once connected, current and future projects in that workspace can use the service when you ask them to.

01

Open Connectors

From your Edy dashboard, open Connectors and choose the service you want to add.

02

Review the service prompt

You leave Edy only for the service's own consent screen, where the account and requested access are shown.

03

Choose the right resource

Select the Supabase project, GitHub account, or Vercel team that Edy should use.

04

Use it across the workspace

The connection becomes available to every project in that Edy workspace. You do not reconnect for each project.

How permissions work

Access is visible before it is granted.

Each service shows its exact consent screen before Edy receives access. Edy uses that authorization only to perform connector workflows, but the technical scope granted by a service can be broader than one action. The details below explain that difference.

Edy's connector safeguards

  • Authorization happens on the connected service's own consent screen.
  • Connector credentials are encrypted before Edy stores them.
  • Credentials stay on Edy's server and are not written into generated source code.
  • Actions such as repository sync and production deployment remain user initiated.

Service access

What each connector can do.

Supabase

Select a database project and configure generated apps without copying API keys by hand.

projects:read
List the Supabase projects available to the authorized account so you can choose one.
secrets:read
Retrieve the selected project's publishable or anon API key for generated app configuration.

Edy stores the chosen project reference, public URL, and publishable or anon key. The OAuth flow does not copy a service-role key into your generated project.

GitHub

Create a repository and keep your Edy project's source synchronized with it.

repo
Create and update repositories, including private repositories.
read:user
Identify the GitHub account connected to the workspace.
user:email
Read the account email needed to identify the connection.

GitHub's repo scope is broad and can cover public and private repositories the account can access. Edy's product flow uses it for repositories you create or choose through Edy, but the OAuth token itself carries that broader scope.

Vercel

Create a Vercel project, deploy previews, publish production builds, and return the resulting URL to Edy.

Installation and identity
Identify the Vercel user or team where the integration is installed.
Projects and deployments
Create or read projects, upload source files, create deployments, and check deployment status.
Aliases and environment
Read the live alias or domain and provide integration-managed environment variables when deploying.

Vercel controls these permissions in the integration configuration and shows the exact current list during installation. Edy currently uses the project, deployment, alias, and environment capabilities described here.

Project boundaries

Connections are shared. Actions are specific.

Supabase

A project receives the selected Supabase URL and public client key when database configuration is needed.

GitHub

Source is synchronized only when you create or update that project's repository through Edy.

Vercel

Edy sends the project files and required public environment values when you start a deployment.

Publishing

From Edy project to a live URL.

1

Create or connect a GitHub repository

New repositories are private by default, and Edy syncs the current source.

2

Create a Vercel preview

Review the generated deployment on its preview URL before making it public.

3

Confirm production publishing

Edy starts a production deployment only after you choose to publish.

4

Use the returned live URL

Edy saves the deployment status and the stable production alias Vercel assigns.

Disconnecting

You can remove a connection at any time.

Disconnecting a service in Edy deletes the workspace's saved connection. For complete revocation, also remove the Edy OAuth app or integration from that service's account settings. Existing repositories, databases, and deployments are not deleted when you disconnect.

Read the privacy notice