summaryrefslogtreecommitdiff
path: root/doc/web_hooks
diff options
context:
space:
mode:
authorJeroen van Baarsen <jeroenvanbaarsen@gmail.com>2014-02-13 11:55:46 +0100
committerJeroen van Baarsen <jeroenvanbaarsen@gmail.com>2014-02-28 19:30:13 +0100
commit564c37d9b69367fb7384a22edad53c8e75aeb2cb (patch)
tree8466be03d9e579fb89c26f2d5e4490b6296becae /doc/web_hooks
parent049d0cc396669d7b970fc3d23e87eb62b3e57b75 (diff)
downloadgitlab-ce-564c37d9b69367fb7384a22edad53c8e75aeb2cb.tar.gz
Moved all the help files to markdown files:
Files moved: * Workflow * help/ssh * help/webhooks * help/system_hooks * help/public_access * help/permissions
Diffstat (limited to 'doc/web_hooks')
-rw-r--r--doc/web_hooks/web_hooks.md113
1 files changed, 113 insertions, 0 deletions
diff --git a/doc/web_hooks/web_hooks.md b/doc/web_hooks/web_hooks.md
new file mode 100644
index 00000000000..ba8083c3601
--- /dev/null
+++ b/doc/web_hooks/web_hooks.md
@@ -0,0 +1,113 @@
+Project web hooks allow you to trihher an url if new code is pushed or a new issue is created.
+
+---
+
+You can configure web hook to listen for specific events like pushes, issues, merge requests.
+GitLab will send POST request with data to web hook url.
+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.
+
+---
+
+#### Push events
+Triggered when you push to the repository except pushing tags.
+
+**Request body:**
+
+```json
+{
+ "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,
+};
+```
+
+#### Issues events
+
+Triggered when a new issue is created or an existing issue was updated/closed/reopened.
+
+**Request body:**
+
+```json
+{
+ "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
+ }
+}
+```
+
+#### Merge request events
+
+Triggered when a new merge request is created or an existing merge request was updated/merges/closed.
+
+**Request body:**
+
+```json
+{
+ "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":""
+ }
+}
+```