Github

Configure a GitHub connector in Dataworkz using OAuth App registration or PAT Token.

This document describes the Dataworkz connector configuration required to access GitHub. There is 3 option to connect Github from Dataworkz.

1. Oauth Private Connected App

2. PAT (Fine grained or classic token)

3. JWT bearer token (Certificate based)

1. Configuration with Private connected App

Step 1: Create GitHub Connected App

Follow the steps below to create an OAuth app in GitHub for Dataworkz.

1. Go to GitHub settings: https://github.com/settings/profile.

   
2. In the settings panel, select Developer settings: https://github.com/settings/apps.

   
3. Select GitHub Apps and click New GitHub App.

   
4. Configure basic information.

   1. Required fields:

      • App name: Your application name

      • Homepage URL: https://yourapp.com

      
5. Configure the User Authorization Callback URL. The callback URL can be found in Dataworkz UI (see the Connecting to GitHub section for details).

   Copy

   https://<you.domain.com>/dataworkz-web/restApi/oauth/github/get_oauth_token

6. Additional settings:

   • Enable Expire user authorization tokens.

   • Enable Request user authorization (OAuth) during installation.

   
7. Disable webhooks entirely.

   
8. Add the required permissions and scopes for the GitHub API. Select the Read scope for all data that Dataworkz needs to access.

Repository Permissions:

• Contents (read) — for repository content access

• Metadata (read) — basic repository information

1. Installation settings:

   • Select Any account if setting up for an organization.

   
2. Click Create GitHub App. This creates the GitHub connected app.

3. After the app is created, click Generate a Private Key. Save the generated private key for future use.

   
4. Scroll up in the app settings. Locate and copy the Client ID. Save it securely for OAuth configuration in Dataworkz.

5. Click Generate a new client secret. Copy and save the Client Secret immediately.

⚠️ Warning: The client secret is shown only once. Copy and store it before leaving the page.

1. Go to the Advanced option in the left pane. Click Make public so it can be installed in other accounts.

   
2. Admin installation:

   • Admin Role: Installs the app on the organization (one-time setup, not on a single account).

   

Step 2: Configure GitHub Connector in Dataworkz

Prerequisites

• Create a Connected App in GitHub before configuring Dataworkz for GitHub.

• If the connected app setup is not done, capture the Callback URL from Dataworkz UI (see Required Steps, step 3b, for details).

• Record the Client ID and Secret from the connected app. These are required when creating the connector in Dataworkz.

Required Steps

1. Log in to Dataworkz and go to the GitHub section under SaaS Applications, then create a new configuration.

2. Enter the following information:

   1. Client ID — Client ID of the GitHub connected app

   2. Client Secret — Client secret of the GitHub connected app

      
3. Custom app already created:

   1. Select Yes if the connected app has already been created.

   2. Select No. A screen with the redirect URL appears. Copy the redirect URL and go to the GitHub connected app setup to complete it.

   
4. Enter the Workspace name.

5. Enter the Collection name.

6. Click Save. Dataworkz prompts you to enter GitHub credentials. Click Login after entering credentials.

   
7. Dataworkz prompts you to allow connecting to the private instance. Allow this to complete the configuration.

   
8. The newly created connection appears in the list of GitHub configurations.

   

Add Task Configuration

Click the newly created connector, then click the + icon to add a new task configuration for GitHub.

1. Enter a name for the dataset.

2. Select the GitHub repository path to access.

3. Select the branch of the selected repository.

4. Select the appropriate option for reading all historical data or a date range.

5. Enable or disable the Recurring Job toggle.

6. Click Add to save the configuration.

2. Configuration with PAT token

Step 1: Create GitHub Personal Access Token

1. Go to GitHub settings: https://github.com/settings/profile and then select Developer settings: https://github.com/settings/apps.

2. On developer settings page, select Personal Access Token Option. There are 2 ways to create PAT token. Fine grain or Classic token.

   
3. Select Fine-grained token option and click generate new token. Select resource owner as workspace (owner) name that contains all repositories to be accessed using PAT.

   

4. Assign Contents (Read Only) permission to PAT and then click Generate Token.

   
5. Copy generated token to be used in Dataworkz connecton configuration.

6. For Classic token, instead of "Fine-grained token" select "Tokens (classic)" and generate classic token.

   

7. In classic token select scopes as full repo otherwise token will not be able to fetch data from repository(s).

   
8. Click on generate token and copy this PAT for use in dataworkz. Once token is generated then configure SSO to grant access to repositories in organization.

   
9. Click Authorize to grant access and complete auth flow.

Step 2: Dataworkz Configuration for GitHub PAT Token

1. Log in to Dataworkz and go to the GitHub section under SaaS Applications, then create a new configuration.

2. Select Oauth Option as "API key". Enter other information along with PAT token in "API Key" field.

   
3. Click Authorize to check token grant and then click on save.

This completes the Dataworkz configuration for GitHub.