summaryrefslogtreecommitdiff
path: root/doc/system_hooks/system_hooks.md
blob: fe32ca1a9faa7e6c66fa66234314472425d474dc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
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 
}
```