Skip to main content

Integrating GitHub

Capabilities​

DataGrail's GitHub integration provides the following capabilities:

ProductCapability
Request Manager
Request TypesAccess
Identifier CategoriesEmail

Before You Start​

To successfully configure this integration, please ensure you have sufficient privileges:

  • DataGrail User Role: Super Admin, Connections Manager
  • GitHub User Role: Admin

Install the DataGrail App​

  1. Log in to GitHub.
  2. Find the DataGrail GitHub App and select Install.
  3. Select the User Account or Organization you would like to connect to DataGrail. Each account or organization requires a separate integration with DataGrail.
  4. Select Install & Authorize.

Connect to DataGrail​

  1. In DataGrail, navigate to Integrations and select Configure New Integration to search for GitHub.
  2. Select Login to Connect and then click Authorize when prompted to grant the necessary permissions to DataGrail:
Required OAuth Scopes
  • Read access to metadata
  • Read and write access to issues and team discussions

Next Steps​

Now that you've successfully connected the integration, check out the following resources:

Troubleshooting​

If you are unable to successfully connect the integration, review these common troubleshooting steps:

Ensure Required Permissions Are Granted on API Keys/Resources

DataGrail checks required permissions and scopes on API keys/resources used by each integration. If all necessary permissions are not granted, new connections will fail.

Review Required Account Types and User Roles

If users do not have the necessary permissions or the minimum required user role in the connecting system, the connection to DataGrail will fail. Additionally, connections will fail if your account type does not match the one required by the integration.

See Before You Start to review these requirements.

Technical Details​

The GitHub integration uses the GitHub REST API:
Access TypeSynchronous

API Documentation​

Learn more about this API implementation and DataGrail functionality in our API Integration Documentation.

 

Need help?
If you have any questions, please reach out to your dedicated Account Manager or contact us at support@datagrail.io.

Disclaimer: The information contained in this message does not constitute as legal advice. We would advise seeking professional counsel before acting on or interpreting any material.