<iframe src="https://www.googletagmanager.com/ns.html?id=GTM-PP7S83N" height="0" width="0" style="display:none;visibility:hidden">
Tutorial

Install Weavy components to your Retool account

This tutorial will guide you through setting up authentication between Retool and Weavy and installing the Weavy components into your Retool account.

Have Retool ready, and let's get started.

1. Weavy API key and backend

First we need an environment URL and an API key to communicate with the Weavy backend. 

2. Clone repo

The repo contains everything you need to set up and configure authentication and use Weavy as custom components in your Retool app.

Start by cloning the repo 
git clone https://github.com/weavy-labs/weavy-retool-components.git weavy-retool-components

3. Install dependencies

Change your directory to weavy-retool-components and run:
Install 
npm install

4. Environment variables

We need the environment URL and an API key to communicate with the Weavy backend. To make this available for the scripts in the repo, we need to place it in an .env file.
Copy into the .env file in the root of the project 
WEAVY_URL="WY_BACKEND_URL"
WEAVY_APIKEY="WY_API_*****************"
Create an .env file in the root of your project folder, copy and paste the above into the file.

5. Log into Retool

Log in using the following command. You need to provide an API access token with read-and-write scopes for Custom Component Libraries. See the Retool API authentication documentation for instructions on generating an access token.
Log in to Retool CLI 
npm run login
Run this command in the project's root folder.

6. Install Weavy

Once you have your Retool authentication configured, you can run the installation script to upload and configure the Weavy components and the authentication workflow.
Run the script in the project root 
npm run create:weavy

The script will automatically configure the following:

  • It sets a global WEAVY_URL Javascript variable. You can see it under Settings > Advanced settings > Preloaded Javascript in your Retool account.
  • It creates a WeavyAuthentication workflow for authentication token handling in the Workflows section in Retool. The Workflow is configured with your Weavy API key.
  • It creates a WeavyPageNavigation workflow in the Workflows section for saving page metadata that is needed by Weavy Notifications to be able to navigate back to the container their content originated from.  The Workflow is configured with your Weavy API key.
  • It installs the Weavy components under Settings > Custom Components Library in your Retool account.

7. Done!

We now have the foundation to start adding Weavy features to your app.

On this page

Let's start building!

Start adding Weavy features to your Retool app

All tutorials
Ask AI
Support

To access live chat with our developer success team you need a Weavy account.

Sign in or create a Weavy account