Receiving webhooks

Receiving webhooks facilitate integration with third-party applications. These webhooks accept a JSON body containing configuration parameters that can be utilized in build blueprints. Once a receiving webhook is triggered, any blueprint can be used to initiate a new build.

Creating

  1. Click “Receive” under the Webhooks option in the left-side menu.

  2. Click “+ New Receiving Webhook.”

  3. Enter a descriptive name (e.g., “Receive GitHub Events”).

  4. Select the previously created secret.

  5. Click “Save.”

    dispatch form

Once saved, the receiving webhooks should look like this:

dispatch home

Receiving rules

In this case, we don’t want every event to trigger a build. Instead, we want to filter events to only those that affect the branch containing the word “master.” In other words, builds should only be triggered when changes are made to the master branch.

  1. Click the new receiving webhook.

  2. Click the “Receiving Rules” tab.

  3. Select “ref” from the first dropdown (Field dropdown).

  4. Select “Wildcard ~* (case-insensitive)” from the Operator dropdown, similar to the ILIKE operator (in SQL).

  5. Type the word “master.”

You can add as many rules as desired; all of them will be applied using an AND operator. This means that all conditions must be met for the webhook to be triggered.

dispatch rules

Build Matrix

This section allows you to select what to build after a webhook has been received and all rules are valid.

  1. Select the “Matrix Blueprint” tab.

  2. Click the previously created blueprint.

    dispatch rules