summaryrefslogtreecommitdiff
path: root/doc/system_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/system_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/system_hooks')
-rw-r--r--doc/system_hooks/system_hooks.md89
1 files changed, 89 insertions, 0 deletions
diff --git a/doc/system_hooks/system_hooks.md b/doc/system_hooks/system_hooks.md
new file mode 100644
index 00000000000..fe32ca1a9fa
--- /dev/null
+++ b/doc/system_hooks/system_hooks.md
@@ -0,0 +1,89 @@
+Your GitLab instance can perform HTTP POST requests on the following events: `create_project`, `delete_project`, `create_user`, `delete_user` and `change_team_member`.
+
+System hooks can be used, e.g. for logging or changing information in a LDAP server.
+
+#### Hooks request example:
+
+**Project created:**
+
+```json
+{
+ "created_at": "2012-07-21T07:30:54Z",
+ "event_name": "project_create",
+ "name": "StoreCloud",
+ "owner_email": "johnsmith@gmail.com"
+ "owner_name": "John Smit",
+ "path": "stormcloud",
+ "path_with_namespace": "jsmith/stormcloud",
+ "project_id": 74,
+}
+```
+
+**Project destroyed:**
+
+```json
+{
+ "created_at": "2012-07-21T07:30:58Z",
+ "event_name": "project_destroy",
+ "name": "Underscore",
+ "owner_email": "johnsmith@gmail.com"
+ "owner_name": "John Smith",
+ "path": "underscore",
+ "path_with_namespace": "jsmith/underscore",
+ "project_id": 73,
+}
+```
+
+**New Team Member:**
+
+```ruby
+{
+ "created_at": "2012-07-21T07:30:56Z",
+ "event_name": "user_add_to_team",
+ "project_access": "Master",
+ "project_id": 74,
+ "project_name": "StoreCloud",
+ "project_path": "storecloud",
+ "user_email": "johnsmith@gmail.com",
+ "user_name": "John Smith",
+}
+```
+
+**Team Member Removed:**
+
+```json
+{
+ "created_at": "2012-07-21T07:30:56Z",
+ "event_name": "user_remove_from_team",
+ "project_access": "Master",
+ "project_id": 74,
+ "project_name": "StoreCloud",
+ "project_path": "storecloud",
+ "user_email": "johnsmith@gmail.com",
+ "user_name": "John Smith",
+}
+```
+
+**User created:**
+
+```json
+{
+ "created_at": "2012-07-21T07:44:07Z",
+ "email": "js@gitlabhq.com",
+ "event_name": "user_create",
+ "name": "John Smith",
+ "user_id": 41
+}
+```
+
+**User removed:**
+
+```json
+{
+ "created_at": "2012-07-21T07:44:07Z",
+ "email": "js@gitlabhq.com",
+ "event_name": "user_destroy",
+ "name": "John Smith",
+ "user_id": 41
+}
+```