Webhooks

Webhooks are Trigger based, notifications will be sent when a particular event occurs

To show the workings of webhooks, we'll try and integrate webhooks with Discord

Discord Notifications with Webhooks

Pre-requisites

• A Discord Server with access to create Webhook URLs

• BugBase Company Account with an Active Program

Helpful Links

👨‍💼Create a Company Account

📂Programs at BugBase

How do I create a server?Discord

Creating a Webhook - Discord

Before starting the setup, ensure you are logged into your Discord Account and have alteast 1 channel in your Discord server.

1. Create a new channel (or you can use an existing one) in your Discord server.

For this example we will use the #bugbase-webhook channel.

2. Click on the settings for the channel, navigate to the integrations tab and click on add a new webhook channel > settings > integrations > create webhook

3. Once you click on Create Webhook a page will open asking you to enter a name for the webhook and choose a channel. Enter a name for the webhook and select the #bugbase-webhook channel.

4. Click on the Save Changes button and copy the webhook URL. The webhook URL will look something like this: https://discord.com/api/webhooks/123456789/abcdefghijklmnopqrstuvwxyz

Adding the Discord Webhook in BugBase

1. Navigate to the integrations tab located in the settings page of your BugBase Program.

2. Click on the Add button on the Webhooks Integration Card.

3. A modal will appear in which you will need to enter the Webhook URL, params, headers, triggers and the body.

4. Enter your Webhook URL and choose the method as POST. The params and headers are optional.

Discord provides it's Webhook execution documentation, refer the embed below

Discord Developer Portal — API Docs for Bots and DevelopersDiscord Developer Portal

5. You can select multiple triggers for your webhook. The list of all available triggers are given below:

List of triggers for your webhooks:

For Reports

• New Report is Submitted

• Report is Triaged

• Report priority is changed

• New message sent in report chat

• Reward is assigned to the Report

• Report is marked as Duplicate

• Report is marked as Invalid

• Report is marked as Resolved

• Report is marked as Informational

• Report is Closed

For Vulnerabilities

• New Vulnerability is Reported

• Vulnerability is marked as Resolved

• Vulnerability is marked as Ignored

• Vulnerability is marked as Unresolved

• Vulnerability is Retested

In this example we would be using the New Report is Submitted trigger so that whenever a new report is submitted we will send a message to the Discord channel.

6. For the body of this webhook we will use the following template:

{
  "content": "Hey! Please check your dashboard",
  "username": "BugBase Webhook"
}

Alternatively, discord also supports embeds

{
  "username": "BugBase Webhook",
  "embeds": [
    {
      "description": "Please check BugBase dashboard",
      "title": "A new bug reported!"
    }
  ]
}

7. Click on the Save / Update button. This will set the webhook up in BugBase.

8. You can enable/disable the webhook as per your need.

Now the Webhook will send a message on Discord whenever a new report is submitted.

Preview of the Webhook

Simple Message

Embed

🎉 Congratulations! You've successfully integrated a Webhook with your BugBase Program