BuildMaster Documentation

Webhook Monitors

  • Last Modified: 2020-07-18

BuildMaster can receive custom webhook events fired by GitHub and GitLab. Once a webhook event is triggered, BuildMaster can use the payload data it receives to create a new build in one or more applications, or perform other tasks as described in OtterScript.

Configuring a Webhook Monitor

While webhook monitors are dependent on the platform, they are configured within BuildMaster in a similar manner. A webhook monitor may be created at the system level from the Administration > Build Triggers & Scheduled Jobs page, or from the Builds > Triggers tab in the context of an application.

The general configuration for a webhook monitor includes:

  • Some kind of secret key/token used to verify the authenticity of the sender
  • Whether to create a build or execute a custom plan
  • Whether to automatically create build variables to capture the commit ID and branch name

Once these options are configured, a URL (relative to the BuildMaster host) will be provided that will be required by the third-party system.

GitHub Webhook Monitor

In order for BuildMaster to receive webhooks from GitHub, a GitHub Webhook Monitor must be created in BuildMaster first, followed by adding a webhook in GitHub itself. See the GitHub Webhooks documentation for step-by-step instructions.

GitLab Webhook Monitor

In order for BuildMaster to receive webhooks from GitLab, a GitLab Webhook Monitor must be created in BuildMaster first, followed by adding a webhook in GitLab itself. See the GitLab Webhooks documentation for step-by-step instructions.

Is this documentation incorrect or incomplete? Help us by contributing!

This documentation is licensed under CC-BY-SA-4.0 and stored in GitHub.

Generated from commit 7dc9c9e6 on master