BuildBeacon

BETA

Get Started with BuildBeacon

Follow these simple steps to set up BuildBeacon webhook for your GitHub projects and start monitoring your build status in minutes.

1
Register
2
Create Webhook
3
Configure GitHub
4
Enjoy Dashboard
Step 1

Register an Account

Create your BuildBeacon account to get started with monitoring your build workflows.

Quick Setup Checklist

  • Click the "Sign Up" button at the top right corner
  • Complete the registration form with your details
  • Verify your email address
  • Log in to your new BuildBeacon account
Step 2

Create Your First Webhook

After registering and verifying your email, create a webhook to receive GitHub events.

Webhook Setup

  • Navigate to your webhook management page
  • Click "Create New Webhook"
  • Give your webhook a descriptive name
  • Copy the generated webhook URL and secret
Step 3

Configure GitHub Webhook

Set up your GitHub repository to send webhook events to BuildBeacon.

GitHub Configuration Steps

1

Navigate to Repository Settings

Go to your GitHub repository → Settings → Webhooks

2

Add New Webhook

Click "Add webhook" button

3

Configure Webhook URL

Use your unique BuildBeacon webhook URL

4

Set Content Type

Choose "application/json"

5

Add Secret

Use the secret from your webhook page

6

Select Events

Choose specific events to monitor

Required Events Configuration

Workflow runs (Required)

Provides basic workflow execution status and enables build monitoring on the dashboard. This is the minimum required event.

Pull requests (Optional)

Enables PR status tracking and integrates build results with pull request information for better workflow visibility.

Screenshot: Adding a webhook

GitHub Add Webhook Interface
Click to enlarge

GitHub webhook configuration interface

Screenshot: Configuring events

GitHub Webhook Events Configuration
Click to enlarge

Select events to monitor your GitHub Actions

Additional Resources

Step 4

Verify and Enjoy Your Dashboard

Test your webhook configuration and start monitoring your builds in real-time.

Verification Steps

  • Trigger a GitHub workflow run to test the webhook
  • Check the GitHub webhook delivery status
  • Verify workflow data appears in your dashboard
  • Explore your real-time build monitoring

Need Help?

If you encounter any issues during setup or have questions, our support team is here to help you get up and running quickly.