summaryrefslogtreecommitdiff
path: root/doc/api/events.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/events.md')
-rw-r--r--doc/api/events.md52
1 files changed, 42 insertions, 10 deletions
diff --git a/doc/api/events.md b/doc/api/events.md
index 49d99cc43fe..7088eb65bd4 100644
--- a/doc/api/events.md
+++ b/doc/api/events.md
@@ -10,20 +10,52 @@ info: To determine the technical writer assigned to the Stage/Group associated w
### Action Types
-Available action types for the `action` parameter are:
+Available types for the `action` parameter, and the resources that might be affected:
- `approved`
-- `created`
-- `updated`
+ - Merge request
- `closed`
-- `reopened`
-- `pushed`
-- `commented`
-- `merged`
-- `joined`
-- `left`
+ - Epic
+ - Issue
+ - Merge request
+ - Milestone
+- `commented` on any `Noteable` record.
+ - Alert
+ - Commit
+ - Design
+ - Issue
+ - Merge request
+ - Snippet
+- `created`
+ - Design
+ - Epic
+ - Issue
+ - Merge request
+ - Milestone
+ - Project
+ - Wiki page
- `destroyed`
+ - Design
+ - Milestone
+ - Wiki page
- `expired`
+ - Project membership
+- `joined`
+ - Project membership
+- `left`
+ - Project membership
+- `merged`
+ - Merge request
+- `pushed` commits to (or deleted commits from) a repository, individually or in bulk.
+ - Project
+- `reopened`
+ - Epic
+ - Issue
+ - Merge request
+ - Milestone
+- `updated`
+ - Design
+ - Wiki page
Note that these options are in lower case.
@@ -283,7 +315,7 @@ Parameters:
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
-| `project_id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
+| `project_id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) |
| `action` | string | no | Include only events of a particular [action type](#action-types) |
| `target_type` | string | no | Include only events of a particular [target type](#target-types) |
| `before` | date | no | Include only events created before a particular date. [View how to format dates](#date-formatting). |