Github

This document describes the Dataworkz connector configuration required to access Github.

Step 1: Create GitHub Connected App

Follow the steps listed below for creating 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 on "New GitHub App".

   
4. Configure Basic Information

   1. Required Fields:

      • App name: Your Application Name

      • Homepage URL: https://yourapp.com

      
5. Configure User Authorization Callback URL. Callback URL can be found in Dataworkz UI (Refer 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. Important: Disable webhooks entirely

   
8. Permissions/scopes need to be added for Github API. Read scope should be selected for the data that need to be accessed from Github via Dataworkz.

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 will create Github connected App.

3. After successfully creating the app, click on “Generate a Private Key”. Once private key is generated, save it for future use.

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

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

⚠️ Critical: The client secret will only be shown once. Make sure to copy and store it immediately.

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 app on organization (one-time setup, not on a single account)

   

Step 2: Configure Github connector in Dataworkz

Prerequisite

• Before configuring Dataworkz for Github, a "Connected App" needs to be configured in Github.​

• If Connected App setup is not done, then capture Callback URL from Dataworkz UI (Refer Required Steps section 3.b for details)

• Make note of the Client ID & Secret from connected app. These details would be required at the time of creating the connector in Dataworkz.

Required Steps

1. Login to Dataworkz and go to Github section under Saas Applications and then create new configuration.

2. Provide the following information to create Github configuration.

   1. Client Id - Client id of Github connected app

   2. Client Secret - Client secret of Github connected app

      

3. Custom App already created

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

   2. Select "No". Screen with the redirect URL would pop-up. Copy the redirect URL and goto setup Github connected app to complete connected app setup.

   
4. Enter the Workspace name

5. Enter the Collection name

6. Click on save button to save the configuration. System will prompt for Github credentials. Click on login after providing credentials.

   
7. System will prompt to allow connecting to private instance. Allow this setup to complete the Dataworkz configuration for Github .

   
8. Newly created connection would show up in the list of Github configurations.

   

Add Task Configuration

Click the newly created connector and then click + icon to add new task configuration for Github

1. Enter name for the dataset

2. Select the Github repository path that you need to access.

3. Select the branch of the selected repository

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

5. Enable/disable recurring job

6. Click Add to save the configuration

This would complete the Dataworkz configuration for Github