Connecting Existing Components with Vercel Projects

If you have an existing component and want to connect it with a Vercel project, you can link both together. To do so, just add the url of your Vercel project page to a Compass component. Here’s how to do it:

Important: Ensure that you’ve successfully setup the Vercel for Compass app by providing an API token. Otherwise our app can not establish a successful data connection (see last steps below). Please read the Get Started article on how to setup Vercel for Compass.

  1. Get the url of your Vercel project, e.g. https://vercel.com/sebastians-projects-123456/my-vercel-project

  2. Open a Compass component → on the right sidebar you can add a link as “Project” or “Dashboard” (whatever you prefer) like this:

    Screenshot 2024-08-13 at 17.41.05.png

     

  3. After adding it, Vercel for Compass will connect the component with your Vercel project and establish a data connection. If you refresh the page, you’ll see a small label showing the status:

    Screenshot 2024-08-13 at 17.41.53.png

     

  4. That’s it! Every new deployment will appear in your component’s activity now and the metrics are automatically being populated.

 

If the Data connection label is not appearing after a few minutes, there might have been a problem happening in the background. In this case, please reach out to our support team.