GitHub

How to Configure Webhook

1. Log in to the GitHub account and navigate to the repository that requires event based scanning triggering.
2. Navigate to the repository "Settings" menu, see example below:

• Once on the settings page, in the left menu panel choose "Webhooks" under the "Code and automation" category;
• Click the "Add webhook" button in the right top view of the Webhooks panel;

4. The following webhook configuration page will be opened :

• Here, under the "Payload URL", insert the Webhook URL obtained in MDSSC, how to do this is explained above;
• Change "Content type" to "application/json";
• In the "Secret" field, copy your MDSSC API key;
• If the installed MDSSC does not have a publicly signed SSL certificate, then choose "Disable" under the SSL verification option. In this case, the user is presented with the following screen, here is acceptable to click the "Disable, I understand my webhooks may not be secure".

5. In the same view further down, it is possible to configure the event trigger types desired, out of the supported ones.
6. By default, "Just the push event" is selected. If it is necessary to configure triggering based on pull request open or merge, click "Let me select individual events" option, which will open a list of events, ex:

7. Out of the list of events, MDSSC supports only the ones described above, and selected in the below example:

8. After the desired event types were selected, ensure that the "Active" option is ticked.

9. When finishing configuring the webhook, push the "Add webhook" button.
10. To test the webhook, create a test branch and trigger the selected event type.

GitHub Ping Event

After setting up the webhook and clicking "Add webhook", GitHub will automatically send a ping event to MDSSC, to test the connection. When this happens, you can see the following notification:

In order to view the results of the ping event, follow the next steps:

1. Press the "Edit" button on the webhook card:

2. In the opened menu, navigate to "Recent Deliveries":

3. Click on the ping event:

If the webhook setup was completed successfully (explained above), the ping request should return a 200 Response. Example: