Webhook Notification System Setup

Projects on our platform have two options for setting up alerts, PagerDuty and webhook integration. These alerts will help you to keep track of reports and to meet your SLA deadlines.

This article will focus on setting up webhook integration. For information on setting up PagerDuty, click here.

Webhook Integration Overview

You have the option to set up a webhook to receive alerts when new High and Critical bug reports are escalated to your project. Although the webhook is a general purpose mechanism, our strategy is to incorporate the most commonly used messaging services one by one. Please scroll down to the ‘Supported Services’ section for the current list of supported services.

In general, you can set up a webhook by selecting the 'Webhook' tab in the Immunefi Dashboard settings. Your options will include the following: 

• Setup guide button: The button links to relevant documentation for the connection and disconnection of a webhook.
  
  
• Not connected/Active/Inactive status indicator: Quick visual clue of current status of the webhook mechanism.
  
  
• + Add Webhook: This button will show up only if no webhook is already connected, and will allow the user the complete the set up of a new webhook by specifying/doing the following:
  
  
  • URL: This is the URL that targets a supported messaging service and it should contain any needed API keys/secrets to successfully hit the service and be able to pass the payload (message data) to that service.
    
    
  • Test Webhook: This button allows the user to test the webhook and on success, it will enable the “Save” button (See below.) On success, you will receive a test notification on the target service.
    
    
  • Save: Once the webhook is successfully tested, this button will save the URL and complete the setup process.
    
    
• Remove Webhook: This button will show up only if a webhook is already connected and allows the user to remove, or disconnect an active or inactive webhook.

Supported Services.

Slack.

Slack provides excellent documentation on how to obtain the URL that represents the “Incoming webhook” that the user needs to create in order to receive the notifications from Immunefi platform. 

Please see https://api.slack.com/messaging/webhooks

This URL includes all relevant details like the Slack user and Slack channel, and it is the only piece of information that is needed to set up the webhook mechanism at Immunefi platform. Since this URL may include secrets, it is stored in encrypted format at Immunefi platform.