Configuring GitHub Webhooks

Preferred: Lineai GitHub App

Installing the Lineai GitHub App on your GitHub organization or account is the preferred integration: it delivers pull request events to Lineai and avoids manual repository webhook setup. See that page for benefits and how the app relates to Change Request configuration. Use the webhook steps in this section only if you cannot use the GitHub App or need a legacy repository webhook configuration. The Manual Installation wizard also guides webhook setup when you are not using the GitHub App.

Obtain the GitHub webhook secret from your Lineai administrator. You will enter this value when configuring the repository webhook in GitHub.

The following steps walk you through creating a webhook for Lineai’s Change Request feature. To learn more about webhooks and how they are configured in GitHub, please refer to the GitHub Docs.

• Log in to GitHub.
• Within the settings page of your organization, select Webhooks from the menu on the left.
• Click Add webhook.
• Enter the payload URL.

Important

The payload URL is comprised of your server’s address and /lineai/server/webhooks/github/payload For example, if your server name is myserver.com, then your payload URL would be https://myserver.com/lineai/server/webhooks/github/payload

• From the Content type drop-down menu, select application/json.
• If you are using SSL verification select Enable SSL verification.
• Add the webhook secret provided by your Lineai administrator.
• Select Let me select individual events.
• Select the following events:
  • Pull requests
  • Pull request review comments
  • Pull request reviews
  • Pull request review threads
• Click Add webhook.

Continue with Configuring Agents for scan matching options.