Configure Webhooks for Github

Modified on Wed, 8 Apr at 5:14 AM

Overview

Webhooks enable real-time communication between GitHub repositories and the Cubyts platform. Once configured, Cubyts can automatically analyze pull requests, commits, and review activity to generate actionable insights.

Prerequisites

Before setting up the webhook, ensure you have:

Admin access to the target GitHub repository.
Access to the Cubyts platform.
Generated Payload URL and Secret from the Cubyts GitHub integration page.

Step-by-Step Setup

Navigate to Webhook Settings

Open your GitHub repository.
Go to Settings.
Click on Webhooks.
Select Add webhook.

Or directly access:

https://github.com/<your-repo>/settings/hooks/new

Configure Webhook Details

Fill in the following fields:

Payload URL

Paste the Payload URL generated from Cubyts.
Note: The payload URL will be available at the repository level in the Cubyts Github integration page.

Secret

Enter the Secret generated from Cubyts.
Note: The secret will be available at the repository level in the Cubyts Github integration page.

Content Type

Set to: application/json.

SSL Verification

Ensure this is set to: Enable SSL verification.

Select Events

Enable the following events:

Pull request review comments
Pull request review threads
Pull request reviews
Pull requests
Pushes

Final Configuration

Ensure the following settings are correctly configured:

Setting	Value
URL	Cubyts Payload URL
Secret Token	Generated from Cubyts
Content Type	application/json
SSL Verification	Enabled
Events	List mentioned earlier

Click Add webhook to complete the setup.

Note: Please ensure that only one webhook is created for a repo (pointing to the Cubyts payload URL).

Notes & Best Practices

A webhook must be configured per repository.
Keep your Secret secure and do not expose it publicly.
If you regenerate the secret in Cubyts, update it in GitHub immediately.
Avoid duplicate webhooks for the same repository.