Commit 887c0c67acdc4f9b847ea27d293328b09e703d8d
1 parent
d4c50dbd
Exists in
master
and in
4 other branches
Update WebHook help page
Signed-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>
Showing
1 changed file
with
58 additions
and
6 deletions
Show diff stats
app/views/help/web_hooks.html.haml
| 1 | = render layout: 'help/layout' do | 1 | = render layout: 'help/layout' do |
| 2 | - %h3.page-title Web hooks | 2 | + %h3.page-title Project web hooks |
| 3 | + %p.light | ||
| 4 | + Project web hooks allow you to trigger url if new code is pushed or new issue is created | ||
| 5 | + %hr | ||
| 3 | 6 | ||
| 4 | - %p.slead | ||
| 5 | - Every GitLab project can trigger a web server whenever the repo is pushed to. | 7 | + %p |
| 8 | + You can configure web hook to listen for specific events like pushes, issues, merge requests. | ||
| 6 | %br | 9 | %br |
| 7 | - Web Hooks can be used to update an external issue tracker, trigger CI builds, update a backup mirror, or even deploy to your production server. | 10 | + GitLab will send POST request with data to web hook url. |
| 8 | %br | 11 | %br |
| 9 | - GitLab will send POST request with commits information on every push. | ||
| 10 | - %h5 Hooks request example: | 12 | + Web Hooks can be used to update an external issue tracker, trigger CI builds, update a backup mirror, or even deploy to your production server. |
| 13 | + | ||
| 14 | + | ||
| 15 | + %h4 Push events | ||
| 11 | = render "projects/hooks/data_ex" | 16 | = render "projects/hooks/data_ex" |
| 12 | 17 | ||
| 18 | + | ||
| 19 | + %h4 Issues events | ||
| 20 | + %pre | ||
| 21 | + :preserve | ||
| 22 | + { | ||
| 23 | + "object_kind":"issue", | ||
| 24 | + "object_attributes":{ | ||
| 25 | + "id":301, | ||
| 26 | + "title":"New API: create/update/delete file", | ||
| 27 | + "assignee_id":51, | ||
| 28 | + "author_id":51, | ||
| 29 | + "project_id":14, | ||
| 30 | + "created_at":"2013-12-03T17:15:43Z", | ||
| 31 | + "updated_at":"2013-12-03T17:15:43Z", | ||
| 32 | + "position":0, | ||
| 33 | + "branch_name":null, | ||
| 34 | + "description":"Create new API for manipulations with repository", | ||
| 35 | + "milestone_id":null, | ||
| 36 | + "state":"opened", | ||
| 37 | + "iid":23 | ||
| 38 | + } | ||
| 39 | + } | ||
| 40 | + %h4 Merge request events | ||
| 41 | + %pre | ||
| 42 | + :preserve | ||
| 43 | + { | ||
| 44 | + "object_kind":"merge_request", | ||
| 45 | + "object_attributes":{ | ||
| 46 | + "id":99, | ||
| 47 | + "target_branch":"master", | ||
| 48 | + "source_branch":"ms-viewport", | ||
| 49 | + "source_project_id":14, | ||
| 50 | + "author_id":51, | ||
| 51 | + "assignee_id":6, | ||
| 52 | + "title":"MS-Viewport", | ||
| 53 | + "created_at":"2013-12-03T17:23:34Z", | ||
| 54 | + "updated_at":"2013-12-03T17:23:34Z", | ||
| 55 | + "st_commits":null, | ||
| 56 | + "st_diffs":null, | ||
| 57 | + "milestone_id":null, | ||
| 58 | + "state":"opened", | ||
| 59 | + "merge_status":"unchecked", | ||
| 60 | + "target_project_id":14, | ||
| 61 | + "iid":1, | ||
| 62 | + "description":"" | ||
| 63 | + } | ||
| 64 | + } |