Skip to content

G
gitlab-ce
Commit c584e43a authored by Marcel Amirault's avatar Marcel Amirault
Browse files
Options

Merge branch 'fix-webhooks-documentation' into 'master' 

Fix Webhooks and System hooks documentation

See merge request gitlab-org/gitlab!71640
parents e56d9a8f ab8dab30
Hide whitespace changes
Inline Side-by-side
Showing with 124 additions and 81 deletions
doc/system_hooks/system_hooks.md
View file @ c584e43a
...@@ -173,7 +173,7 @@ Please refer to `group_rename` and `user_rename` for that case. ...@@ -173,7 +173,7 @@ Please refer to `group_rename` and `user_rename` for that case.
"user_name": "John Smith", "user_name": "John Smith",
"user_username": "johnsmith", "user_username": "johnsmith",
"user_id": 41, "user_id": 41,
"project_visibility": "visibilitylevel|private" "project_visibility": "private"
} }
``` ```
...@@ -193,7 +193,7 @@ Please refer to `group_rename` and `user_rename` for that case. ...@@ -193,7 +193,7 @@ Please refer to `group_rename` and `user_rename` for that case.
"user_name": "John Smith", "user_name": "John Smith",
"user_username": "johnsmith", "user_username": "johnsmith",
"user_id": 41, "user_id": 41,
"project_visibility": "visibilitylevel|private" "project_visibility": "private"
} }
``` ```
...@@ -213,7 +213,7 @@ Please refer to `group_rename` and `user_rename` for that case. ...@@ -213,7 +213,7 @@ Please refer to `group_rename` and `user_rename` for that case.
"user_name": "John Smith", "user_name": "John Smith",
"user_username": "johnsmith", "user_username": "johnsmith",
"user_id": 41, "user_id": 41,
"project_visibility": "visibilitylevel|private" "project_visibility": "private"
} }
``` ```
...@@ -519,7 +519,7 @@ X-Gitlab-Event: System Hook ...@@ -519,7 +519,7 @@ X-Gitlab-Event: System Hook
} }
``` ```
### Merge request events ## Merge request events
Triggered when a new merge request is created, an existing merge request was Triggered when a new merge request is created, an existing merge request was
updated/merged/closed or a commit is added in the source branch. updated/merged/closed or a commit is added in the source branch.
...@@ -533,101 +533,89 @@ X-Gitlab-Event: System Hook ...@@ -533,101 +533,89 @@ X-Gitlab-Event: System Hook
```json ```json
{ {
"object_kind": "merge_request", "object_kind": "merge_request",
"event_type": "merge_request",
"user": { "user": {
"id": 1, "id": 1,
"name": "Administrator", "name": "Administrator",
"username": "root", "username": "root",
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon", "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=40\u0026d=identicon",
"email": "admin@example.com" "email": "admin@example.com"
}, },
"project": { "project": {
"name": "Example", "id": 1,
"description": "", "name":"Gitlab Test",
"web_url": "http://example.com/jsmith/example", "description":"Aut reprehenderit ut est.",
"avatar_url": null, "web_url":"http://example.com/gitlabhq/gitlab-test",
"git_ssh_url": "git@example.com:jsmith/example.git", "avatar_url":null,
"git_http_url": "http://example.com/jsmith/example.git", "git_ssh_url":"git@example.com:gitlabhq/gitlab-test.git",
"namespace": "Jsmith", "git_http_url":"http://example.com/gitlabhq/gitlab-test.git",
"visibility_level": 0, "namespace":"GitlabHQ",
"path_with_namespace": "jsmith/example", "visibility_level":20,
"default_branch": "master", "path_with_namespace":"gitlabhq/gitlab-test",
"ci_config_path": "", "default_branch":"master",
"homepage": "http://example.com/jsmith/example", "homepage":"http://example.com/gitlabhq/gitlab-test",
"url": "git@example.com:jsmith/example.git", "url":"http://example.com/gitlabhq/gitlab-test.git",
"ssh_url": "git@example.com:jsmith/example.git", "ssh_url":"git@example.com:gitlabhq/gitlab-test.git",
"http_url": "http://example.com/jsmith/example.git" "http_url":"http://example.com/gitlabhq/gitlab-test.git"
},
"repository": {
"name": "Gitlab Test",
"url": "http://example.com/gitlabhq/gitlab-test.git",
"description": "Aut reprehenderit ut est.",
"homepage": "http://example.com/gitlabhq/gitlab-test"
}, },
"object_attributes": { "object_attributes": {
"id": 90, "id": 99,
"target_branch": "master", "target_branch": "master",
"source_branch": "ms-viewport", "source_branch": "ms-viewport",
"source_project_id": 14, "source_project_id": 14,
"author_id": 51, "author_id": 51,
"assignee_id": 6, "assignee_id": 6,
"title": "MS-Viewport", "title": "MS-Viewport",
"created_at": "2017-09-20T08:31:45.944Z", "created_at": "2013-12-03T17:23:34Z",
"updated_at": "2017-09-28T12:23:42.365Z", "updated_at": "2013-12-03T17:23:34Z",
"milestone_id": null, "milestone_id": null,
"state": "opened", "state": "opened",
"merge_status": "unchecked", "merge_status": "unchecked",
"target_project_id": 14, "target_project_id": 14,
"iid": 1, "iid": 1,
"description": "", "description": "",
"updated_by_id": 1,
"merge_error": null,
"merge_params": {
"force_remove_source_branch": "0"
},
"merge_when_pipeline_succeeds": false,
"merge_user_id": null,
"merge_commit_sha": null,
"deleted_at": null,
"in_progress_merge_commit_sha": null,
"lock_version": 5,
"time_estimate": 0,
"last_edited_at": "2017-09-27T12:43:37.558Z",
"last_edited_by_id": 1,
"head_pipeline_id": 61,
"ref_fetched": true,
"merge_jid": null,
"source": { "source": {
"name": "Awesome Project", "name":"Awesome Project",
"description": "", "description":"Aut reprehenderit ut est.",
"web_url": "http://example.com/awesome_space/awesome_project", "web_url":"http://example.com/awesome_space/awesome_project",
"avatar_url": null, "avatar_url":null,
"git_ssh_url": "git@example.com:awesome_space/awesome_project.git", "git_ssh_url":"git@example.com:awesome_space/awesome_project.git",
"git_http_url": "http://example.com/awesome_space/awesome_project.git", "git_http_url":"http://example.com/awesome_space/awesome_project.git",
"namespace": "root", "namespace":"Awesome Space",
"visibility_level": 0, "visibility_level":20,
"path_with_namespace": "awesome_space/awesome_project", "path_with_namespace":"awesome_space/awesome_project",
"default_branch": "master", "default_branch":"master",
"ci_config_path": "", "homepage":"http://example.com/awesome_space/awesome_project",
"homepage": "http://example.com/awesome_space/awesome_project", "url":"http://example.com/awesome_space/awesome_project.git",
"url": "http://example.com/awesome_space/awesome_project.git", "ssh_url":"git@example.com:awesome_space/awesome_project.git",
"ssh_url": "git@example.com:awesome_space/awesome_project.git", "http_url":"http://example.com/awesome_space/awesome_project.git"
"http_url": "http://example.com/awesome_space/awesome_project.git"
}, },
"target": { "target": {
"name": "Awesome Project", "name":"Awesome Project",
"description": "Aut reprehenderit ut est.", "description":"Aut reprehenderit ut est.",
"web_url": "http://example.com/awesome_space/awesome_project", "web_url":"http://example.com/awesome_space/awesome_project",
"avatar_url": null, "avatar_url":null,
"git_ssh_url": "git@example.com:awesome_space/awesome_project.git", "git_ssh_url":"git@example.com:awesome_space/awesome_project.git",
"git_http_url": "http://example.com/awesome_space/awesome_project.git", "git_http_url":"http://example.com/awesome_space/awesome_project.git",
"namespace": "Awesome Space", "namespace":"Awesome Space",
"visibility_level": 0, "visibility_level":20,
"path_with_namespace": "awesome_space/awesome_project", "path_with_namespace":"awesome_space/awesome_project",
"default_branch": "master", "default_branch":"master",
"ci_config_path": "", "homepage":"http://example.com/awesome_space/awesome_project",
"homepage": "http://example.com/awesome_space/awesome_project", "url":"http://example.com/awesome_space/awesome_project.git",
"url": "http://example.com/awesome_space/awesome_project.git", "ssh_url":"git@example.com:awesome_space/awesome_project.git",
"ssh_url": "git@example.com:awesome_space/awesome_project.git", "http_url":"http://example.com/awesome_space/awesome_project.git"
"http_url": "http://example.com/awesome_space/awesome_project.git"
}, },
"last_commit": { "last_commit": {
"id": "ba3e0d8ff79c80d5b0bbb4f3e2e343e0aaa662b7", "id": "da1560886d4f094c3e6c9ef40349f7d38b5d27d7",
"message": "fixed readme", "message": "fixed readme",
"timestamp": "2017-09-26T16:12:57Z", "timestamp": "2012-01-03T23:36:29+02:00",
"url": "http://example.com/awesome_space/awesome_project/commits/da1560886d4f094c3e6c9ef40349f7d38b5d27d7", "url": "http://example.com/awesome_space/awesome_project/commits/da1560886d4f094c3e6c9ef40349f7d38b5d27d7",
"author": { "author": {
"name": "GitLab dev user", "name": "GitLab dev user",
...@@ -635,16 +623,61 @@ X-Gitlab-Event: System Hook ...@@ -635,16 +623,61 @@ X-Gitlab-Event: System Hook
} }
}, },
"work_in_progress": false, "work_in_progress": false,
"total_time_spent": 0, "url": "http://example.com/diaspora/merge_requests/1",
"human_total_time_spent": null, "action": "open",
"human_time_estimate": null "assignee": {
"name": "User1",
"username": "user1",
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=40\u0026d=identicon"
}
}, },
"labels": null, "labels": [{
"repository": { "id": 206,
"name": "git-gpg-test", "title": "API",
"url": "git@example.com:awesome_space/awesome_project.git", "color": "#ffffff",
"description": "", "project_id": 14,
"homepage": "http://example.com/awesome_space/awesome_project" "created_at": "2013-12-03T17:15:43Z",
"updated_at": "2013-12-03T17:15:43Z",
"template": false,
"description": "API related issues",
"type": "ProjectLabel",
"group_id": 41
}],
"changes": {
"updated_by_id": {
"previous": null,
"current": 1
},
"updated_at": {
"previous": "2017-09-15 16:50:55 UTC",
"current":"2017-09-15 16:52:00 UTC"
},
"labels": {
"previous": [{
"id": 206,
"title": "API",
"color": "#ffffff",
"project_id": 14,
"created_at": "2013-12-03T17:15:43Z",
"updated_at": "2013-12-03T17:15:43Z",
"template": false,
"description": "API related issues",
"type": "ProjectLabel",
"group_id": 41
}],
"current": [{
"id": 205,
"title": "Platform",
"color": "#123123",
"project_id": 14,
"created_at": "2013-12-03T17:15:43Z",
"updated_at": "2013-12-03T17:15:43Z",
"template": false,
"description": "Platform related issues",
"type": "ProjectLabel",
"group_id": 41
}]
}
} }
} }
``` ```
......
doc/user/project/integrations/webhooks.md
View file @ c584e43a
...@@ -131,6 +131,7 @@ X-Gitlab-Event: Push Hook ...@@ -131,6 +131,7 @@ X-Gitlab-Event: Push Hook
```json ```json
{ {
"object_kind": "push", "object_kind": "push",
"event_name": "push",
"before": "95790bf891e76fee5e1747ab589903a6a1f80f22", "before": "95790bf891e76fee5e1747ab589903a6a1f80f22",
"after": "da1560886d4f094c3e6c9ef40349f7d38b5d27d7", "after": "da1560886d4f094c3e6c9ef40349f7d38b5d27d7",
"ref": "refs/heads/master", "ref": "refs/heads/master",
...@@ -221,6 +222,7 @@ X-Gitlab-Event: Tag Push Hook ...@@ -221,6 +222,7 @@ X-Gitlab-Event: Tag Push Hook
```json ```json
{ {
"object_kind": "tag_push", "object_kind": "tag_push",
"event_name": "tag_push",
"before": "0000000000000000000000000000000000000000", "before": "0000000000000000000000000000000000000000",
"after": "82b3d5ae55f7080f1e6022629cdb57bfae7cccc7", "after": "82b3d5ae55f7080f1e6022629cdb57bfae7cccc7",
"ref": "refs/tags/v1.0.0", "ref": "refs/tags/v1.0.0",
...@@ -449,6 +451,7 @@ X-Gitlab-Event: Note Hook ...@@ -449,6 +451,7 @@ X-Gitlab-Event: Note Hook
```json ```json
{ {
"object_kind": "note", "object_kind": "note",
"event_type": "note",
"user": { "user": {
"id": 1, "id": 1,
"name": "Administrator", "name": "Administrator",
...@@ -531,6 +534,7 @@ X-Gitlab-Event: Note Hook ...@@ -531,6 +534,7 @@ X-Gitlab-Event: Note Hook
```json ```json
{ {
"object_kind": "note", "object_kind": "note",
"event_type": "note",
"user": { "user": {
"id": 1, "id": 1,
"name": "Administrator", "name": "Administrator",
...@@ -660,6 +664,7 @@ X-Gitlab-Event: Note Hook ...@@ -660,6 +664,7 @@ X-Gitlab-Event: Note Hook
```json ```json
{ {
"object_kind": "note", "object_kind": "note",
"event_type": "note",
"user": { "user": {
"id": 1, "id": 1,
"name": "Administrator", "name": "Administrator",
...@@ -755,6 +760,9 @@ X-Gitlab-Event: Note Hook ...@@ -755,6 +760,9 @@ X-Gitlab-Event: Note Hook
NOTE: NOTE:
`assignee_id` field is deprecated and now shows the first assignee only. `assignee_id` field is deprecated and now shows the first assignee only.
NOTE:
`event_type` is set to `confidential_note` for confidential issues.
#### Comment on code snippet #### Comment on code snippet
**Request header**: **Request header**:
...@@ -768,6 +776,7 @@ X-Gitlab-Event: Note Hook ...@@ -768,6 +776,7 @@ X-Gitlab-Event: Note Hook
```json ```json
{ {
"object_kind": "note", "object_kind": "note",
"event_type": "note",
"user": { "user": {
"id": 1, "id": 1,
"name": "Administrator", "name": "Administrator",
...@@ -856,6 +865,7 @@ X-Gitlab-Event: Merge Request Hook ...@@ -856,6 +865,7 @@ X-Gitlab-Event: Merge Request Hook
```json ```json
{ {
"object_kind": "merge_request", "object_kind": "merge_request",
"event_type": "merge_request",
"user": { "user": {
"id": 1, "id": 1,
"name": "Administrator", "name": "Administrator",
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7