Fire webhook on new deployment

Problem to solve

It would be great to fire webhook when new deployments happen to any environment. A deployment is an interesting event for many reasons and having a webhook available for deployment activities will allow for interesting kinds of automation and/or notifications to be built on top of that event.

Further details

Would like to have webhooks fire for deployments happen.

Backend Proposal

• Add field deployment_events boolean DEFAULT false NOT NULL to web_hooks table
• Fire webhooks when deployment status is updated to final status (succesfull/failed)
  • Include job ID, environment name and deployments status in the web-hook body.
• Add the checkbox described in the UX proposal
• Add API field deployment_events to web-hooks API
• Update docs for web-hooks
• Update docs for the API

UX Proposal

• Add a new checkbox under Settings > Webhooks for Deployment events.
• By default, the checkbox should be unselected.
• Content of changes:

Deployment events

[ ] Event will be triggered when a deployment has started/finished

What does success look like, and how can we measure that?

• Webhooks fire on deployments
• Include job ID and environment name in the deployment notification.

This page may contain information related to upcoming products, features and functionality. It is important to note that the information presented is for informational purposes only, so please do not rely on the information for purchasing or planning purposes. Just like with all projects, the items mentioned on the page are subject to change or delay, and the development, release, and timing of any products, features, or functionality remain at the sole discretion of GitLab Inc.