Notifications

Enabling notifications from Probo allows you to be automatically informed about your builds’ status and completion. Notifications are delivered by the Probo Notifier service, which listens for build events and dispatches them through one of its notification plugins. Probo currently supports webhook POST notifications, Slack messages and Jira issue comments.

Webhook Notifications

Get started with webhook notifications by adding a notifications key to your .probo.yaml file. Within this notifications key, add your webhook POST URL. You can add a single URL or multiple URLs. The webhook plugin sends a POST request with build event data to your configured URL(s) on every build event.

Examples

notifications:
  webhook: https://example.com/api/probo-notification

notifications:
  webhook:
    - https://example.com/api/probo-notification1
    - https://example.com/api/probo-notification2

Webhook Payload

The body of the POST request is a JSON object describing the event and the build that triggered it. The event field identifies the type of event - for example, ready is sent when a build completes. A typical payload looks like this:

{
  "event": "ready",
  "eventData": {},
  "image": "proboci/ubuntu-18.04-lamp:latest",
  "provider": "github",
  "repo": "awesome-drupal-project",
  "slug": "tizzo/awesome-drupal-project",
  "active": true,
  "name": "tizzo/awesome-drupal-project",
  "organizationId": "5560a4d5-a3cf-4099-bb1c-9e9abb51d417",
  "organization": "tizzo",
  "owner": "tizzo",
  "build": {
    "status": "running",
    "createdAt": "2016-06-15T03:45:08.431Z",
    "updatedAt": "2016-06-15T03:45:08.727Z",
    "reaped": false,
    "reapedReason": null,
    "projectId": "bee7244f-9b97-44e6-8952-951495b2e738",
    "pinned": null,
    "name": null,
    "id": "d571d17d-ce03-4689-9cf1-d829caebbb9a",
    "links": {
      "pullRequest": "http://bee7244f--pr-9.local.probo.build",
      "branch": "http://bee7244f--br-pr-to-close.local.probo.build",
      "build": "http://d571d17d.local.probo.build"
    },
    "pullRequest": {
      "description": "",
      "htmlUrl": "https://github.com/tizzo/awesome-drupal-project/pull/9",
      "name": "Doing a simple build.",
      "number": "9"
    },
    "commit": {
      "htmlUrl": "https://github.com/tizzo/awesome-drupal-project/commit/37ec694b",
      "ref": "37ec694b41ebe39e99f429e9f0eb67d7a63a7ec9"
    },
    "branch": {
      "htmlUrl": "https://github.com/tizzo/awesome-drupal-project/tree/pr-to-close",
      "name": "pr-to-close"
    },
    "config": {},
    "container": {},
    "diskSpace": {
      "realBytes": 0,
      "virtualBytes": 0
    },
    "steps": []
  }
}

Top-Level Fields

Build Fields

Slack Notifications

The Slack plugin sends a message to one or more Slack channels when a build completes. It requires a Slack app with an incoming webhook URL, which you can create at api.slack.com/apps.

For security, Slack webhook URLs are not stored in your .probo.yaml file. Instead, upload a probo-credentials.yml asset file to your project containing the webhook URL(s):

notifications:
  slack:
    webhook:
      - https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX

Then enable Slack notifications in your .probo.yaml file:

notifications:
  slack: true

Or provide a custom message:

notifications:
  slack:
    message: "Build ready for `$PROJECT_NAME` on `$BRANCH_NAME` at $BUILD_URL"

Jira Notifications

The Jira plugin automatically adds a comment to a Jira issue when a build completes. The issue is identified from the branch name, so your branches must follow the format PROJECTKEY-123/optional-description - for example, DEV-42/add-login-page. If the branch name does not match this pattern, no comment is posted.

Add your Jira credentials to your probo-credentials.yml asset file:

notifications:
  jira:
    url: https://yourcompany.atlassian.net
    user: jira-user@example.com
    password: your-api-token

Then enable Jira notifications in your .probo.yaml file:

notifications:
  jira: true

Or provide a custom message:

notifications:
  jira:
    message: "Probo build ready for $PROJECT_NAME on branch $BRANCH_NAME: $BUILD_URL"

Message Template Variables

The following variables can be used in custom Slack and Jira messages:

Related Articles & Information

---

Managing Probo Build Assets Configuring the .probo.yaml File