1. Using Visual Builder Studio
  2. Maximize the Power of Your Project
  3. Send Notifications to External Software Using Webhooks
  4. Slack
  5. Configure a Slack Webhook in VB Studio to Send Event Notifications

Configure a Slack Webhook in VB Studio to Send Event Notifications

The Slack webhook is a outgoing webhook that sends VB Studio event notifications to a Slack channel.

The project owner can create and configure a webhook:

  1. In the left navigator, click Project Administration Project Administration.
  2. Click Webhooks.
  3. Click + Create Webhook.
  4. From Type, select Slack.
  5. In Name, enter a unique name.
  6. In URL, enter or paste the Slack channel’s incoming Webhook URL.
    Make sure it's in the https://hooks.slack.com/services/... format.
  7. In Events, select the type(s) of events that trigger the webhook and then, under the filter, select from the item(s) displayed or use a regular expression to make a more complex selection (a range or ranges, perhaps) that involves multiple items that match a pattern. See Glob Pattern Reference for Matching Branch, Job, and Pipeline Names for detailed information about the syntax for regular expressions.

    Note:

    The Glob Pattern is only available for Repository/Branch filtering with Git Push and Merge Request event types. The filter for Build event types doesn't currently support using the Glob pattern.

    Here's what you can choose from.

    Events area in the Create Webhook page, showing Build event types selected, and a filter that narrows messages to just those from job A_Job_Pipeline_Branch1

    Let's say you want to add event notifications from a build job that is triggered by an SCM commit to a selected repository (configured in the job configuration page's Git tab). To do this, you'd select Build then, under Build Job Filter at the bottom of the page, click + Add Filter and select the job whose event messages will be streamed to the channel you specified in step 6.

    Since the build job was triggered by an SCM commit, the Slack message will include information such as commit message(s), the author's name, the duration, and other details. This information helps identify what was being processed and who was responsible for it.

    If you select Git Push or Merge Request, click + Add Filter in Repository/Branch Filter, and use the menu to select the repository and branch to track.

  8. Click Create.
  9. To test the webhook, click Test.
  10. Click Done when you're satisfied that it works.
When VB Studio events happen, notifications are sent to the Slack channel.
Description of slack_more_devcs_events.png follows
Description of the illustration slack_more_devcs_events.png