diff options
Diffstat (limited to 'doc/api/services.md')
| -rw-r--r-- | doc/api/services.md | 23 |
1 files changed, 15 insertions, 8 deletions
diff --git a/doc/api/services.md b/doc/api/services.md index 0b840d907f8..e658c51f7e6 100644 --- a/doc/api/services.md +++ b/doc/api/services.md @@ -7,7 +7,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Services API **(FREE)** NOTE: -This API requires an access token with Maintainer or Owner permissions +This API requires an access token with Maintainer or Owner permissions. ## List all active services @@ -42,7 +42,7 @@ Example response: "wiki_page_events": true, "job_events": true, "comment_on_event_enabled": true - } + }, { "id": 76, "title": "Alerts endpoint", @@ -572,7 +572,9 @@ GET /projects/:id/services/external-wiki ## Flowdock -Flowdock is a collaboration web app for technical teams. +Flowdock is a ChatOps application for collaboration in software engineering +companies. You can send notifications from GitLab events to Flowdock flows. +For integration instructions, see the [Flowdock documentation](https://www.flowdock.com/help/gitlab). ### Create/Edit Flowdock service @@ -1251,7 +1253,7 @@ Parameters: | `confidential_issue_channel` | string | false | The name of the channel to receive confidential issues events notifications | | `merge_request_channel` | string | false | The name of the channel to receive merge request events notifications | | `note_channel` | string | false | The name of the channel to receive note events notifications | -| `confidential_note_channel` | boolean | The name of the channel to receive confidential note events notifications | +| `confidential_note_channel` | string | false | The name of the channel to receive confidential note events notifications | | `tag_push_channel` | string | false | The name of the channel to receive tag push events notifications | | `pipeline_channel` | string | false | The name of the channel to receive pipeline events notifications | | `wiki_page_channel` | string | false | The name of the channel to receive wiki page events notifications | @@ -1326,10 +1328,15 @@ PUT /projects/:id/services/jenkins Parameters: -- `jenkins_url` (**required**) - Jenkins URL like `http://jenkins.example.com` -- `project_name` (**required**) - The URL-friendly project name. Example: my_project_name -- `username` (optional) - A user with access to the Jenkins server, if applicable -- `password` (optional) - The password of the user +| Parameter | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `jenkins_url` | string | true | Jenkins URL like `http://jenkins.example.com`. | +| `project_name` | string | true | The URL-friendly project name. Example: `my_project_name`. | +| `username` | string | false | Username for authentication with the Jenkins server, if authentication is required by the server. | +| `password` | string | false | Password for authentication with the Jenkins server, if authentication is required by the server. | +| `push_events` | boolean | false | Enable notifications for push events. | +| `merge_requests_events` | boolean | false | Enable notifications for merge request events. | +| `tag_push_events` | boolean | false | Enable notifications for tag push events. | ### Delete Jenkins CI service |