Configuring SCM for GitSync

To use the GitSync feature in Syntasa, the first step is to configure your Git repository settings under Admin Center → Infrastructure. This allows Syntasa to connect securely to your Git-based source control system (SCM) and push application workflow content into your chosen repository and branch.

Once the Git Repo toggle is enabled, several fields become visible. Each of these fields plays a critical role in allowing the GitSync feature to function correctly.

Below is a detailed explanation of each field:

SCM Type

This dropdown lets you select the Source Code Management (SCM) platform where your Git repository is hosted. Syntasa currently supports: GitHub, GitLab and Bitbucket

Choose the appropriate platform based on your organization’s Git setup. This selection determines the expected format of the repository URL and the type of token needed for authentication.

Repository URL

This field accepts the URL of your Git repository, which changes based on the chosen Auth Type:

If using Access Token (HTTPS-based):

If using SSH Key:

  • Format: git@<host>:<org>/<repo>.git
  • Examples:
    • GitHub: git@github.com:example-org/my-repo.git
    • GitLab: git@gitlab.com:example-group/my-app.git
    • Bitbucket: git@bitbucket.org:myteam/myrepo.git

Make sure the repository URL format matches the authentication method exactly; otherwise, connection validation will fail.

Auth Type

This dropdown allows you to choose how Syntasa should authenticate with your Git repository. Two authentication types are supported:

  • Access Token (HTTPS Authentication)

    This is the most common and secure method for automating access to Git repositories. There are two types of tokens you can use:

    • Personal Access Token (PAT): A user-level token that gives Syntasa access to all repositories the user can access. Best suited for development and multi-repo operations.

    • Repository-Level Token: A more secure, limited-scope token that grants access only to a specific repository. Ideal for production or minimal-permission use cases.

    When Auth Type is selected as Access Token, a field by name Access Token will appear to enter the token key. The access token should match the required scopes depending on your SCM and intended access level (repo vs account). This value is securely stored and only used for GitSync operations like commit and push.

    Note: When Bitbucket is selected as the SCM type, an additional field for Username will appear.

  • SSH Key Authentication

    With this method, Syntasa connects to your Git repository using an SSH key pair. Use this method if your organization standardizes on SSH-only access or wants to avoid token expiration. The public key must be added to your Git account or repository access settings.

    • Generate an SSH key pair if not already available.
    • Add the public key to your SCM’s SSH configuration.
    • Upload the private key file in the field SSH Key File securely into Syntasa’s configuration.

    When Auth Type is selected as SSH Key, a field named SSH Key will appear to enter the SSH key. Upload your private SSH key here. Make sure it matches the public key configured in your Git account. Syntasa uses this key to authenticate Git operations over SSH.

Test Repo

Before proceeding further, click Test Repo to validate your credentials and repository settings.

✅ A successful test:

  • Confirms the repository exists and is accessible.
  • Retrieves the list of available branches from the repository.
  • Automatically populates the “Name of Branch” dropdown.

❌ A failed test:

  • Indicates invalid credentials or incorrect repository URL.
  • Prevents you from continuing. GitSync and saving this configuration will remain blocked until fixed.\

Note: Testing the repository is mandatory. Without a successful test, the branch field cannot be populated, and the configuration cannot be saved.

Name of Branch

This field lists the Git branches retrieved from the repository after a successful test.

  • It remains disabled until the Test Repo step is completed.
  • You must select a branch to proceed.
  • This is the branch where workflow files will be committed during GitSync.

If your branch is missing from the list, double-check:

  • The token or SSH key has access to that branch.
  • The branch already exists in the repository, or not(Syntasa does not create new branches).

Name of Base Path (Optional)

Specify a subdirectory path inside the repository where you want workflow files to be stored.

Examples:

  • syntasa/dev
  • prod/exports
  • workflows/version1

Leaving this blank will result in files being stored at the root of the branch.