From d54d900daae272f26efc7d5af99b714706b8bbd0 Mon Sep 17 00:00:00 2001 From: Marcia Ramos Date: Mon, 8 Aug 2016 21:34:01 +0000 Subject: [PATCH 1/2] Update web_hooks.md - EE-features --- doc/web_hooks/web_hooks.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/doc/web_hooks/web_hooks.md b/doc/web_hooks/web_hooks.md index af466e1ec549f3..25279d49d8e5bf 100644 --- a/doc/web_hooks/web_hooks.md +++ b/doc/web_hooks/web_hooks.md @@ -1,3 +1,32 @@ +---- + +## What are GitLab Webhooks about? + +[Webhooks](https://en.wikipedia.org/wiki/Webhook) are "user-defined HTTP +callbacks". They are usually triggered by some +event, such as pushing code to a repository or a comment being posted to a blog. +When that event occurs, the source app makes an HTTP request to the URI +configured for the webhook. The action taken may be anything. +Common uses are to trigger builds with continuous integration systems or to +notify bug tracking systems. + +Webhooks are available per project for GitLab CE, and **per project** and +**per group** for **GitLab EE**. + +In most cases, you'll need to setup your own [webhook receiver](#example-webhook-receiver) +to receive infomation from GitLab and send it to another app, according to your needs. +We already have a [built-in receiver](http://docs.gitlab.com/ce/project_services/slack.html) +for sending [Slack](https://api.slack.com/incoming-webhooks) notifications _per project_. + +## Use-cases + +- You can setup a webhook in GitLab to send a notification to [Slack](https://api.slack.com/incoming-webhooks) +every time a build fails, for example. +- You can [integrate with Twilio to be notified via SMS](https://www.datadoghq.com/blog/send-alerts-sms-customizable-webhooks-twilio/) +every time an issue is created for a specific project or group within GitLab. + +---- + # Webhooks > **Note:** As of GitLab 8.5: -- GitLab From 8936275619ab52f48c722864a9185978c6d97aec Mon Sep 17 00:00:00 2001 From: Marcia Ramos Date: Thu, 18 Aug 2016 02:25:34 +0000 Subject: [PATCH 2/2] adjustments based on https://gitlab.com/gitlab-com/marketing/issues/336#note_13718538 --- doc/web_hooks/web_hooks.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/doc/web_hooks/web_hooks.md b/doc/web_hooks/web_hooks.md index 25279d49d8e5bf..1f5fc9a5f483c6 100644 --- a/doc/web_hooks/web_hooks.md +++ b/doc/web_hooks/web_hooks.md @@ -1,6 +1,13 @@ ----- -## What are GitLab Webhooks about? +# Webhooks + +> **Note:** As of GitLab 8.5: +> +> - the `repository` key is deprecated in favor of the `project` key +> - the `project.ssh_url` key is deprecated in favor of the `project.git_ssh_url` key +> - the `project.http_url` key is deprecated in favor of the `project.git_http_url` key + +## Overview [Webhooks](https://en.wikipedia.org/wiki/Webhook) are "user-defined HTTP callbacks". They are usually triggered by some @@ -10,11 +17,11 @@ configured for the webhook. The action taken may be anything. Common uses are to trigger builds with continuous integration systems or to notify bug tracking systems. -Webhooks are available per project for GitLab CE, and **per project** and -**per group** for **GitLab EE**. +Webhooks are available **per project** for GitLab CE, and **per project and +per group** for **GitLab EE**. In most cases, you'll need to setup your own [webhook receiver](#example-webhook-receiver) -to receive infomation from GitLab and send it to another app, according to your needs. +to receive infomation from GitLab, and send it to another app, according to your needs. We already have a [built-in receiver](http://docs.gitlab.com/ce/project_services/slack.html) for sending [Slack](https://api.slack.com/incoming-webhooks) notifications _per project_. @@ -22,18 +29,11 @@ for sending [Slack](https://api.slack.com/incoming-webhooks) notifications _per - You can setup a webhook in GitLab to send a notification to [Slack](https://api.slack.com/incoming-webhooks) every time a build fails, for example. -- You can [integrate with Twilio to be notified via SMS](https://www.datadoghq.com/blog/send-alerts-sms-customizable-webhooks-twilio/) +- You can [integrate with Twilio to be notified via SMS](https://www.datadoghq.com/blog/send-alerts-sms-customizable-webhooks-twilio/). every time an issue is created for a specific project or group within GitLab. +- You can use them to [automatically assign labels to merge requests](https://about.gitlab.com/2016/08/19/applying-gitlab-labels-automatically/). ----- - -# Webhooks - -> **Note:** As of GitLab 8.5: -> -> - the `repository` key is deprecated in favor of the `project` key -> - the `project.ssh_url` key is deprecated in favor of the `project.git_ssh_url` key -> - the `project.http_url` key is deprecated in favor of the `project.git_http_url` key +## Description Project webhooks allow you to trigger an URL if new code is pushed or a new issue is created. -- GitLab