summaryrefslogtreecommitdiff
path: root/doc/api/triggers.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/triggers.md')
-rw-r--r--doc/api/triggers.md94
1 files changed, 94 insertions, 0 deletions
diff --git a/doc/api/triggers.md b/doc/api/triggers.md
new file mode 100644
index 00000000000..6adcc8fe3b8
--- /dev/null
+++ b/doc/api/triggers.md
@@ -0,0 +1,94 @@
+# Triggers
+
+## List project triggers
+
+Get a list of project triggers
+
+```
+GET /projects/:id/triggers
+```
+
+Parameters:
+
+- `id` (required) - The ID of a project
+
+```json
+[
+ {
+ "created_at": "2015-12-23T16:24:34.716Z",
+ "deleted_at": null,
+ "id": 1,
+ "last_used": "2016-01-04T15:41:21.986Z",
+ "token": "fbdb730c2fbdb095a0862dbd8ab88b",
+ "updated_at": "2015-12-23T16:24:34.716Z"
+ },
+ {
+ "created_at": "2015-12-23T16:25:56.760Z",
+ "deleted_at": null,
+ "id": 2,
+ "last_used": null,
+ "token": "7b9148c158980bbd9bcea92c17522d",
+ "updated_at": "2015-12-23T16:25:56.760Z"
+ }
+]
+```
+
+## Get trigger details
+
+Get details of trigger of a project
+
+```
+GET /projects/:id/triggers/:trigger_id
+```
+
+Parameters:
+
+- `id` (required) - The ID of a project
+- `trigger_id` (required) - The ID of a trigger
+
+```json
+{
+ "created_at": "2015-12-23T16:25:56.760Z",
+ "deleted_at": null,
+ "id": 2,
+ "last_used": null,
+ "token": "7b9148c158980bbd9bcea92c17522d",
+ "updated_at": "2015-12-23T16:25:56.760Z"
+}
+```
+
+## Create a project trigger
+
+Create a trigger for a project
+
+```
+POST /projects/:id/triggers
+```
+
+Parameters:
+
+- `id` (required) - The ID of a project
+
+```json
+{
+ "created_at": "2016-01-07T09:53:58.235Z",
+ "deleted_at": null,
+ "id": 5,
+ "last_used": null,
+ "token": "6d056f63e50fe6f8c5f8f4aa10edb7",
+ "updated_at": "2016-01-07T09:53:58.235Z"
+}
+```
+
+## Remove a project trigger
+
+Remove a trigger of a project
+
+```
+DELETE /projects/:id/triggers/:trigger_id
+```
+
+Parameters:
+
+- `id` (required) - The ID of a project
+- `trigger_id` (required) - The ID of a trigger