deploy.dog Notifications/Integrations

In addition to webhooks which allow your own custom notifications, we hav some pre-built integrations to make things easy for you.

All notifications are defined within your Deploy config section. If you haven't already, you should read the Getting Started documentation first.

Slack

The Slack integration will post messages to the channel of your choice upon deploy success and/or failure, so your team can stay in the loop.

- type: slack
  onSuccess: true
  onFailure: true
  url: https://hooks.slack.com/services/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
  channel: "#dev-team"
{
  "type": "slack",
  "onSuccess": true,
  "onFailure": true,
  "url": "https://hooks.slack.com/services/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",
  "channel": "#dev-team"
}
Parameter Type/Value Notes Required
type slack Indicates that this Notification entry is for the Slack integration.  Required
onSuccess boolean Should this notification module trigger on successful deployments/rollbacks? Defaults to true.  Optional
onFailure boolean Should this notification module trigger on failed deployments/rollbacks? Defaults to true.  Optional
url string You need to login to Slack and create and incoming webhook. You'll then be given a Webhook URL - that's what you need for this parameter.  Required
channel string The name of your Slack channel (including preceding hash/number symbol # as in the code example above). For valid YAML you will need to double-quote this value.  Required

HipChat

The HipChat integration will post messages to the channel of your choice upon deploy success and/or failure, so your team can stay in the loop.

- type: hipchat
  onSuccess: true
  onFailure: true
  apiToken: c3ca4c19e9372735202431b41b25cd
  roomName: Dev Team
{
  "type": "hipchat",
  "onSuccess": true,
  "onFailure": true,
  "apiToken": "c3ca4c19e9372735202431b41b25cd",
  "roomName": "Dev Team"
}
Parameter Type/Value Notes Required
type hipchat Indicates that this Notification entry is for the HipChat integration.  Required
onSuccess boolean Should this notification module trigger on successful deployments/rollbacks? Defaults to true.  Optional
onFailure boolean Should this notification module trigger on failed deployments/rollbacks? Defaults to true.  Optional
apiToken string From your HipChat website account, go to Group admin > API and create a new token. The Type of "Notification" is fine, although "Admin" will work too.  Required
roomName string The name of the HipChat room that you'd like messages to go to.  Required

Sentry

The Sentry integration will create a release and a deployment on your Sentry account with easy deployment though deploy.dog. Releases are used by Sentry to improve its error reporting abilities by correlating first seen events with the release that might have introduced the problem.

- type: sentry
  onSuccess: true
  authToken: 9e52f239811e14e458ecd131e06c15c3211a05f6fd645b890dd949ccded1cc5f
  organizationSlug: my-org
  projectSlugs:
    - my-project
  repositoryConnected: true
[
  {
    "type": "sentry",
    "onSuccess": true,
    "authToken": "9e52f239811e14e458ecd131e06c15c3211a05f6fd645b890dd949ccded1cc5f",
    "organizationSlug": "my-org",
    "projectSlugs": [
      "my-project"
    ],
    "repositoryConnected": true
  }
]
Parameter Type/Value Notes Required
type sentry Indicates that this Notification entry is for the HipChat integration.  Required
onSuccess boolean Should this notification module trigger on successful deployments/rollbacks? Defaults to true. Changing this to false will effectively disable this notification.  Optional
authToken string Generate an auth token from https://sentry.io/api/ with at least the project:releases scope.  Required
organizationSlug string The slug of the organization on Sentry. When viewing your project on the Sentry website, the url is in the format https://sentry.io/[organizationSlug]/[projectSlug]/.  Required
projectSlugs array of strings A list of project slugs on Sentry that are involved in this release.  Required
repositoryConnected boolean Defaults to false to be on the safe side. If you have connected your repository to your Sentry project then set this option to true for better release/deploy data, including commit data. Highly recommended where possible.  Required
sentryServer string An optional Sentry server (if you host it yourself). Defaults to https://sentry.io for the hosted Sentry service.  Required

More Coming Soon

We have more notifications/integrations in the pipeline, so watch this space. We're working on the following (in no particular order):

  • GitHub (deployment notifications)
  • GitLab (deployment notifications and the ability to trigger from withing GitLab CI's Pipelines feature)
  • New Relic
  • Bugsnag
  • Rollbar
  • Flowdock
  • SMS (Twilio)
  • Emails

If what you're looking for is not listed, send a request to hello@deploy.dog and we'll do our best to accommodate it.