View all connectors

GitHub webhooks

DX supports GitHub webhooks ingestion to sync data in real-time. Webhooks are optional, but recommended in order to ensure real-time data accuracy in DX.

A single webhook delivers events to one DX endpoint (/webhooks/github); the events you select determine which connectors receive real-time data:

  • GitHub: pull request data (pull requests, pull request reviews, and optionally review comments).
  • GitHub Actions: workflow run and workflow job data.

GitHub webhooks can be configured at the repository, organization, and GitHub App levels. For detailed instructions on creating webhooks, refer to the official GitHub documentation.

Setup instructions

The steps below describe adding webhooks at the organization level:

  1. Go to Organization settings > Webhooks
  2. Click Add webhook
  3. For the Payload URL input field, enter https://yourinstance.getdx.net/webhooks/github but with your unique subdomain
  4. Enter your DX webhooks secret which can be found on the Connections admin page
  5. Select “Let me select individual events”
  6. Select the events for the data you want to sync in real-time (see below), then click Add webhook

Pull request events

For the GitHub connector:

  • Uncheck Pushes
  • Check Pull requests and Pull request reviews
  • (Optional) Check Pull request review comments to update the review comment count in real-time

Here’s what your settings should look like:

GitHub Actions events

For the GitHub Actions connector:

  • Check Workflow runs and Workflow jobs