116 lines
3.5 KiB
Plaintext
116 lines
3.5 KiB
Plaintext
= render layout: 'help/layout' do
|
|
%h3.page-title Project web hooks
|
|
%p.light
|
|
Project web hooks allow you to trigger url if new code is pushed or new issue is created
|
|
%hr
|
|
|
|
%p.slead
|
|
You can configure web hook to listen for specific events like pushes, issues, merge requests.
|
|
%br
|
|
GitLab will send POST request with data to web hook url.
|
|
%br
|
|
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.
|
|
%hr
|
|
|
|
%h4 Push events
|
|
%p.light
|
|
Triggered when you push to the repository except pushing tags.
|
|
%br
|
|
Request body:
|
|
= highlight_js do
|
|
:erb
|
|
{
|
|
"before": "95790bf891e76fee5e1747ab589903a6a1f80f22",
|
|
"after": "da1560886d4f094c3e6c9ef40349f7d38b5d27d7",
|
|
"ref": "refs/heads/master",
|
|
"user_id": 4,
|
|
"user_name": "John Smith",
|
|
"project_id": 15,
|
|
"repository": {
|
|
"name": "Diaspora",
|
|
"url": "git@localhost:diaspora.git",
|
|
"description": "",
|
|
"homepage": "http://localhost/diaspora",
|
|
},
|
|
"commits": [
|
|
{
|
|
"id": "b6568db1bc1dcd7f8b4d5a946b0b91f9dacd7327",
|
|
"message": "Update Catalan translation to e38cb41.",
|
|
"timestamp": "2011-12-12T14:27:31+02:00",
|
|
"url": "http://localhost/diaspora/commits/b6568db1bc1dcd7f8b4d5a946b0b91f9dacd7327",
|
|
"author": {
|
|
"name": "Jordi Mallach",
|
|
"email": "jordi@softcatala.org",
|
|
}
|
|
},
|
|
// ...
|
|
{
|
|
"id": "da1560886d4f094c3e6c9ef40349f7d38b5d27d7",
|
|
"message": "fixed readme",
|
|
"timestamp": "2012-01-03T23:36:29+02:00",
|
|
"url": "http://localhost/diaspora/commits/da1560886d4f094c3e6c9ef40349f7d38b5d27d7",
|
|
"author": {
|
|
"name": "GitLab dev user",
|
|
"email": "gitlabdev@dv6700.(none)",
|
|
},
|
|
},
|
|
],
|
|
"total_commits_count": 4,
|
|
};
|
|
|
|
|
|
%h4.prepend-top-20 Issues events
|
|
%p.light
|
|
Triggered when new issue created or existing issue was updated/closed/reopened.
|
|
%br
|
|
Request body:
|
|
= highlight_js do
|
|
:erb
|
|
{
|
|
"object_kind":"issue",
|
|
"object_attributes":{
|
|
"id":301,
|
|
"title":"New API: create/update/delete file",
|
|
"assignee_id":51,
|
|
"author_id":51,
|
|
"project_id":14,
|
|
"created_at":"2013-12-03T17:15:43Z",
|
|
"updated_at":"2013-12-03T17:15:43Z",
|
|
"position":0,
|
|
"branch_name":null,
|
|
"description":"Create new API for manipulations with repository",
|
|
"milestone_id":null,
|
|
"state":"opened",
|
|
"iid":23
|
|
}
|
|
}
|
|
%h4.prepend-top-20 Merge request events
|
|
%p.light
|
|
Triggered when new merge request created or existing merge request was updated/merged/closed.
|
|
%br
|
|
Request body:
|
|
= highlight_js do
|
|
:erb
|
|
{
|
|
"object_kind":"merge_request",
|
|
"object_attributes":{
|
|
"id":99,
|
|
"target_branch":"master",
|
|
"source_branch":"ms-viewport",
|
|
"source_project_id":14,
|
|
"author_id":51,
|
|
"assignee_id":6,
|
|
"title":"MS-Viewport",
|
|
"created_at":"2013-12-03T17:23:34Z",
|
|
"updated_at":"2013-12-03T17:23:34Z",
|
|
"st_commits":null,
|
|
"st_diffs":null,
|
|
"milestone_id":null,
|
|
"state":"opened",
|
|
"merge_status":"unchecked",
|
|
"target_project_id":14,
|
|
"iid":1,
|
|
"description":""
|
|
}
|
|
}
|