To enable the GitHub Actions connector, you need a GitHub App ID and Private Key PEM file. Note—if your GitHub instance is behind a firewall or has IP restrictions, you must allowlist DX IP addresses in order to accept inbound API requests.

See the schema reference for Pipeline >

Steps to connect

Steps 1 - 5 must be completed by a GitHub Organization Owner.

Step 1

Log in to your GitHub account, and browse to the URL below with ORGANIZATION replaced with your GitHub organization username:

https://github.com/organizations/ORGANIZATION/settings/apps/new?public=false&url=https://getdx.com&actions=read

This will pre-populate default settings needed for your GitHub App to be used with DX. The list of needed permissions are listed below.

Repository permissions:

Read-only access to Actions

Step 2

Scroll to the bottom of the page and click the "Create GitHub App" button.

Step 3

The App ID will be shown at the top of the subsequent screen. Copy this ID down so it can be entered into DX later.

Step 4

On the same screen, scroll down to the "Private keys" heading and click "Generate a private key" which will initiate a download of a PEM file. Copy the contents of this file to be entered into DX later.

Step 5

Click on the "Install App" link in the sidebar navigation and then click "Install" beside your GitHub organization.

✅ To get your initial data imported as quickly as possible, please select only your most important repositories initially, then come back and select more later.

By default, public repositories are not imported. If you would like public repositories to be imported, please contact DX Support.

Step 6

Navigate to the Data Cloud > Connections screen within DX, then add a connection using your credentials generated in the previous steps.

Updating permissions

To update your GitHub App permissions, go to your organization's Developer Settings and click on GitHub Apps.

From there, click on Edit for the GitHub App you are using for DX and then navigate to the Permissions & events tab. After making changes, scroll down to the bottom of the page and click Save changes.

To apply these changes, go to the Install App tab, click on the gear icon for each organization listed, and then click and accept the Review request as shown in the images below.

API Reference

Endpoint URL	Documentation Link	Permissions Needed (via GitHub App)
/repos/{repo}/actions/runs	List Workflow Runs for a Repository	actions:read
/repos/{repo}/actions/runs/{run_id}	Get a Workflow Run	actions:read
/repos/{repo}/actions/runs/{run_id}/jobs	List Jobs for a Workflow Run	actions:read
/repos/{repo}/actions/runs/{source_workflow_id}/timing	Get Workflow Run Usage	actions:read

Errors

This table lists error codes that you may encounter when adding a connection in DX.

Error	Description
`invalid_credentials`	Your API credentials entered are not valid.
`invalid_permissions`	Your GitHub App installation does not have the permissions required by DX.
`no_resources`	Your GitHub App installation cannot access any repositories.
`private_key_needed`	The key passed in is not an RSA private key.