Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
8bb39137
Commit
8bb39137
authored
Jun 27, 2017
by
Achilleas Pipinellis
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update webhooks docs
parent
658b8eb5
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
18 additions
and
21 deletions
+18
-21
doc/user/project/integrations/webhooks.md
doc/user/project/integrations/webhooks.md
+18
-21
No files found.
doc/user/project/integrations/webhooks.md
View file @
8bb39137
...
...
@@ -6,6 +6,16 @@ Starting from GitLab 8.5:
-
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
Project webhooks allow you to trigger a URL if for example new code is pushed or
a new issue is created. You can configure webhooks to listen for specific events
like pushes, issues or merge requests. GitLab will send a POST request with data
to the webhook URL.
In most cases, you'll need to setup your own
[
webhook receiver
](
#example-webhook-receiver
)
to receive information 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_.
## Overview
[
Webhooks
](
https://en.wikipedia.org/wiki/Webhook
)
are "_user-defined HTTP
...
...
@@ -14,37 +24,24 @@ 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.
notify bug tracking systems.
Webhooks are available
**per project**
for GitLab Community Edition,
and
**per project and per group**
for
**GitLab Enterprise Edition**
.
Webhooks can be used to update an external issue tracker, trigger CI jobs,
update a backup mirror, or even deploy to your production server.
They are available
**per project**
for GitLab Community Edition,
and
**per project and per group**
for
**GitLab Enterprise Edition**
.
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_.
Navigate to the webhooks page by going to your project's
**Settings ➔ Integrations**
.
## 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
[
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
-
You can use them to
[
automatically assign labels to merge requests
](
https://about.gitlab.com/2016/08/19/applying-gitlab-labels-automatically/
)
.
## Description
Project webhooks allow you to trigger a URL if for example new code is pushed or
a new issue is created. You can configure webhooks to listen for specific events
like pushes, issues or merge requests. GitLab will send a POST request with data
to the webhook URL.
Webhooks can be used to update an external issue tracker, trigger CI jobs,
update a backup mirror, or even deploy to your production server.
Navigate to the webhooks page by going to your project's
**Settings ➔ Integrations**
.
## Webhook endpoint tips
If you are writing your own endpoint (web server) that will receive
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment