GitHub
GitHub Sync connects your Nected workspace to a GitHub repository so your team can version-control Rules, Workflows, Integrations, and Datasets directly through Git. Once connected, you can push, pull, review, and merge changes using the same workflows developers already use for application code.
This guide walks you through the requirements and exact steps to configure GitHub Sync for your workspace admin.
Important Notes Before You Begin
Single-Installation vs Multi-Installation Behavior
Cloud (Single Installation): A Git repo cannot be connected to more than one workspace. To allow additional users to push/pull:
Add them to the same Nected workspace
Give them appropriate GitHub access (repo RW or branch-specific RW for fine-grained tokens)
Self-Hosted (Multi-Installation): A Git repository can be connected to multiple workspaces.
Step 1: Create a GitHub Repository
Go to https://github.com/new
Create a new repository
Copy either of the following:
The HTTPS URL (e.g.,
https://github.com/org/repo.git)The SSH URL (e.g.,
[email protected]:org/repo.git)
Nected accepts both HTTPS and SSH URLs.
Step 2: Generate a Personal Access Token
Once the GitHub repo is created, you need to give access to the repository you want to connect to. To do that, you need to permit by creating a Fine-grained Personal Access Token or Classic Token. To do so, you need to go to: GitHub → Settings → Developer Settings
Now, follow these steps:
Fine-Grained Token (Recommended)
Click on Personal access tokens → Fine-grained tokens
Click Generate new token
Fill up all the details and then choose the target repository
Under Repository permissions, enable:
Contents → Read and Write
Generate and copy the token securely
Classic Token (Supported)
Select the scope "repo" as only the repo (Read & Write) scope is required.
Important: GitHub only shows tokens once. Store yours securely.
Step 3: Configure Git in Nected
Once a Git repository is connected to a Nected workspace, it cannot be changed later. Configure the correct repository during setup.
Follow these steps to configure the repository in your workspace:
In Nected, open the left sidebar
Scroll to the bottom and click Git Repository
Select Connect to Git A configuration dialog will appear.
Note: Connecting a Git repository, selecting the default branch, setting the token, and completing initial configuration can only be done by a Nected workspace admin.
Enter the required fields:
Repository URL
Paste the HTTPS URL of your GitHub repo
Personal Access Token
Paste your Fine-grained token created in Step 2
The dialog displays helpful tooltips for repository URL formats.
Click Configure Git A loading message appears: “Please wait while we connect to git”
If successful, Nected will show:
A green success banner: “Successfully connected to Github”
Sidebar transforms to include:
Branch dropdown
Push
Pull
Settings gear icon
Step 4: Select the Default Branch
Immediately after connecting, Nected prompts you to choose your default branch.
Typically main or master.
Select the branch from the Select default branch dropdown
Click Save You will see a success message confirming the default branch selection
The selected default branch represents your production-ready source of truth.
Troubleshooting GitHub Setup
SSH Key Misconfiguration
If using SSH and GitHub does not detect your deploy key, Nected will show: “It seems that your SSH key hasn’t been added to your repository…”
To resolve:
Add the generated public key to GitHub → Repo → Deploy Keys
Ensure it has write permissions
Retry configuration
Token Expiration
If your Fine-grained token expires, you will see: “Personal Access Token is expired, Please update.”
Update it from: Workspace Settings → Git Repo → Personal access token → Update
Repository Permissions Issues
If Nected cannot commit or pull:
Ensure your Fine-grained token includes Contents: Read & Write
Ensure the token is scoped to the correct repository
Next Steps
Once GitHub Sync is successfully configured, you can begin:
Working on branches to isolate changes
Committing and pushing updates from Nected into GitHub
Pulling branch updates into your workspace for review
Merging and deploying approved logic to production
Last updated