services.md 28.4 KB
Newer Older
1
# Services API
2

Mark Chao's avatar
Mark Chao committed
3
>**Note:** This API requires an access token with Maintainer or Owner permissions
4

Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
5 6 7 8 9 10 11 12
## Asana

Asana - Teamwork without email

### Create/Edit Asana service

Set Asana service for a project.

Evan Read's avatar
Evan Read committed
13
> This service adds commit messages as comments to Asana tasks. Once enabled, commit messages are checked for Asana task URLs (for example, `https://app.asana.com/0/123456/987654`) or task IDs starting with # (for example, `#987654`). Every task ID found will get the commit comment added to it. You can also close a task with a message containing: `fix #123456`. You can find your Api Keys here: <https://asana.com/developers/documentation/getting-started/auth#api-key>.
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
14 15 16 17 18 19 20

```
PUT /projects/:id/services/asana
```

Parameters:

21 22 23 24
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `api_key` | string | true | User API token. User must have access to task, all comments will be attributed to this user. |
| `restrict_to_branch` | string | false | Comma-separated list of branches which will be automatically inspected. Leave blank to include all branches. |
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
25 26 27 28 29 30 31 32 33

### Delete Asana service

Delete Asana service for a project.

```
DELETE /projects/:id/services/asana
```

34 35 36 37 38 39 40 41
### Get Asana service settings

Get Asana service settings for a project.

```
GET /projects/:id/services/asana
```

Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
42 43 44 45 46 47 48 49 50 51 52 53 54 55
## Assembla

Project Management Software (Source Commits Endpoint)

### Create/Edit Assembla service

Set Assembla service for a project.

```
PUT /projects/:id/services/assembla
```

Parameters:

56 57 58 59
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `token` | string | true | The authentication token
| `subdomain` | string | false | The subdomain setting |
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
60 61 62 63 64 65 66 67 68

### Delete Assembla service

Delete Assembla service for a project.

```
DELETE /projects/:id/services/assembla
```

69 70 71 72 73 74 75 76
### Get Assembla service settings

Get Assembla service settings for a project.

```
GET /projects/:id/services/assembla
```

Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
77 78
## Atlassian Bamboo CI

79
A continuous integration and build server
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
80 81 82 83 84 85 86 87 88 89 90 91 92

### Create/Edit Atlassian Bamboo CI service

Set Atlassian Bamboo CI service for a project.

> You must set up automatic revision labeling and a repository trigger in Bamboo.

```
PUT /projects/:id/services/bamboo
```

Parameters:

93 94
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
Evan Read's avatar
Evan Read committed
95
| `bamboo_url` | string | true | Bamboo root URL. For example, `https://bamboo.example.com`. |
96 97 98
| `build_key` | string | true | Bamboo build plan key like KEY |
| `username` | string | true | A user with API access, if applicable |
| `password` | string | true | Password of the user |
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
99 100 101 102 103 104 105 106 107

### Delete Atlassian Bamboo CI service

Delete Atlassian Bamboo CI service for a project.

```
DELETE /projects/:id/services/bamboo
```

108 109 110 111 112 113 114 115
### Get Atlassian Bamboo CI service settings

Get Atlassian Bamboo CI service settings for a project.

```
GET /projects/:id/services/bamboo
```

116 117 118 119
## Bugzilla

Bugzilla Issue Tracker

Evan Read's avatar
Evan Read committed
120
### Create/Edit Bugzilla service
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153

Set Bugzilla service for a project.

```
PUT /projects/:id/services/bugzilla
```

Parameters:

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `new_issue_url` | string | true |  New Issue url |
| `issues_url` | string | true | Issue url |
| `project_url` | string | true | Project url |
| `description` | string | false | Description |
| `title` | string | false | Title |

### Delete Bugzilla Service

Delete Bugzilla service for a project.

```
DELETE /projects/:id/services/bugzilla
```

### Get Bugzilla Service Settings

Get Bugzilla service settings for a project.

```
GET /projects/:id/services/bugzilla
```

Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
154 155 156 157 158 159 160 161 162
## Buildkite

Continuous integration and deployments

### Create/Edit Buildkite service

Set Buildkite service for a project.

```
163
PUT /projects/:id/services/buildkite
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
164 165 166 167
```

Parameters:

168 169 170
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `token` | string | true | Buildkite project GitLab token |
Evan Read's avatar
Evan Read committed
171
| `project_url` | string | true | `https://buildkite.com/example/project` |
172
| `enable_ssl_verification` | boolean | false | Enable SSL verification |
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
173 174 175 176 177 178

### Delete Buildkite service

Delete Buildkite service for a project.

```
179
DELETE /projects/:id/services/buildkite
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
180 181
```

182 183 184 185 186
### Get Buildkite service settings

Get Buildkite service settings for a project.

```
187
GET /projects/:id/services/buildkite
188 189
```

Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
190 191 192 193 194 195 196 197 198 199 200 201 202 203
## Campfire

Simple web-based real-time group chat

### Create/Edit Campfire service

Set Campfire service for a project.

```
PUT /projects/:id/services/campfire
```

Parameters:

204 205 206 207 208
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `token` | string | true | Campfire token |
| `subdomain` | string | false | Campfire subdomain |
| `room`  | string | false | Campfire room |
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
209 210 211 212 213 214 215 216 217

### Delete Campfire service

Delete Campfire service for a project.

```
DELETE /projects/:id/services/campfire
```

218 219 220 221 222 223 224 225
### Get Campfire service settings

Get Campfire service settings for a project.

```
GET /projects/:id/services/campfire
```

Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
226 227 228 229 230 231 232 233 234 235 236 237 238 239
## Custom Issue Tracker

Custom issue tracker

### Create/Edit Custom Issue Tracker service

Set Custom Issue Tracker service for a project.

```
PUT /projects/:id/services/custom-issue-tracker
```

Parameters:

240 241 242 243 244 245 246
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `new_issue_url` | string | true |  New Issue url
| `issues_url` | string | true | Issue url
| `project_url` | string | true | Project url
| `description` | string | false | Description
| `title` | string | false | Title
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
247 248 249 250 251 252 253 254 255

### Delete Custom Issue Tracker service

Delete Custom Issue Tracker service for a project.

```
DELETE /projects/:id/services/custom-issue-tracker
```

256 257 258 259 260 261 262 263
### Get Custom Issue Tracker service settings

Get Custom Issue Tracker service settings for a project.

```
GET /projects/:id/services/custom-issue-tracker
```

Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
264 265 266 267 268 269 270 271 272 273 274 275 276 277
## Drone CI

Drone is a Continuous Integration platform built on Docker, written in Go

### Create/Edit Drone CI service

Set Drone CI service for a project.

```
PUT /projects/:id/services/drone-ci
```

Parameters:

278 279 280
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `token` | string | true | Drone CI project specific token |
Evan Read's avatar
Evan Read committed
281
| `drone_url` | string | true | `http://drone.example.com` |
282
| `enable_ssl_verification` | boolean | false | Enable SSL verification |
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
283 284 285 286 287 288 289 290 291

### Delete Drone CI service

Delete Drone CI service for a project.

```
DELETE /projects/:id/services/drone-ci
```

292 293 294 295 296 297 298 299
### Get Drone CI service settings

Get Drone CI service settings for a project.

```
GET /projects/:id/services/drone-ci
```

Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
300 301 302 303 304 305 306 307 308 309 310 311 312 313
## Emails on push

Email the commits and diff of each push to a list of recipients.

### Create/Edit Emails on push service

Set Emails on push service for a project.

```
PUT /projects/:id/services/emails-on-push
```

Parameters:

314 315 316 317 318
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `recipients` | string | true | Emails separated by whitespace |
| `disable_diffs` | boolean | false | Disable code diffs |
| `send_from_committer_email` | boolean | false | Send from committer |
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
319 320 321 322 323 324 325 326 327

### Delete Emails on push service

Delete Emails on push service for a project.

```
DELETE /projects/:id/services/emails-on-push
```

328 329 330 331 332 333 334 335
### Get Emails on push service settings

Get Emails on push service settings for a project.

```
GET /projects/:id/services/emails-on-push
```

Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
336 337 338 339 340 341 342 343 344 345 346 347 348 349
## External Wiki

Replaces the link to the internal wiki with a link to an external wiki.

### Create/Edit External Wiki service

Set External Wiki service for a project.

```
PUT /projects/:id/services/external-wiki
```

Parameters:

350 351 352
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `external_wiki_url` | string | true | The URL of the external Wiki |
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
353 354 355 356 357 358 359 360 361

### Delete External Wiki service

Delete External Wiki service for a project.

```
DELETE /projects/:id/services/external-wiki
```

362 363 364 365 366 367 368 369
### Get External Wiki service settings

Get External Wiki service settings for a project.

```
GET /projects/:id/services/external-wiki
```

Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
370 371 372 373 374 375 376 377 378 379 380 381 382 383
## Flowdock

Flowdock is a collaboration web app for technical teams.

### Create/Edit Flowdock service

Set Flowdock service for a project.

```
PUT /projects/:id/services/flowdock
```

Parameters:

384 385 386
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `token` | string | true | Flowdock Git source token |
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
387 388 389 390 391 392 393 394 395

### Delete Flowdock service

Delete Flowdock service for a project.

```
DELETE /projects/:id/services/flowdock
```

396 397 398 399 400 401 402 403
### Get Flowdock service settings

Get Flowdock service settings for a project.

```
GET /projects/:id/services/flowdock
```

404 405 406 407
## Hangouts Chat

Google GSuite team collaboration tool.

408 409
>**Note:** This service was [introduced in v11.2](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/20290)

410 411 412 413 414
### Create/Edit Hangouts Chat service

Set Hangouts Chat service for a project.

```
415
PUT /projects/:id/services/hangouts-chat
416 417 418 419 420 421 422 423
```

>**Note:** Specific event parameters (e.g. `push_events` flag) were [introduced in v10.4][11435]

Parameters:

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
Evan Read's avatar
Evan Read committed
424
| `webhook` | string | true | The Hangouts Chat webhook. For example, `https://chat.googleapis.com/v1/spaces...`. |
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
| `notify_only_broken_pipelines` | boolean | false | Send notifications for broken pipelines |
| `notify_only_default_branch` | boolean | false | Send notifications only for the default branch |
| `push_events` | boolean | false | Enable notifications for push events |
| `issues_events` | boolean | false | Enable notifications for issue events |
| `confidential_issues_events` | boolean | false | Enable notifications for confidential issue events |
| `merge_requests_events` | boolean | false | Enable notifications for merge request events |
| `tag_push_events` | boolean | false | Enable notifications for tag push events |
| `note_events` | boolean | false | Enable notifications for note events |
| `pipeline_events` | boolean | false | Enable notifications for pipeline events |
| `wiki_page_events` | boolean | false | Enable notifications for wiki page events |

### Delete Hangouts Chat service

Delete Hangouts Chat service for a project.

```
441
DELETE /projects/:id/services/hangouts-chat
442 443 444 445 446 447 448
```

### Get Hangouts Chat service settings

Get Hangouts Chat service settings for a project.

```
449
GET /projects/:id/services/hangouts-chat
450 451
```

Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
452 453 454 455 456 457 458 459
## Irker (IRC gateway)

Send IRC messages, on update, to a list of recipients through an Irker gateway.

### Create/Edit Irker (IRC gateway) service

Set Irker (IRC gateway) service for a project.

Evan Read's avatar
Evan Read committed
460
> NOTE: Irker does NOT have built-in authentication, which makes it vulnerable to spamming IRC channels if it is hosted outside of a  firewall. Please make sure you run the daemon within a secured network  to prevent abuse. For more details, read: <http://www.catb.org/~esr/irker/security.html>.
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
461 462 463 464 465 466 467

```
PUT /projects/:id/services/irker
```

Parameters:

468 469 470 471 472 473 474
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `recipients` | string | true | Recipients/channels separated by whitespaces |
| `default_irc_uri` | string | false | irc://irc.network.net:6697/ |
| `server_host` | string | false | localhost |
| `server_port` | integer | false | 6659 |
| `colorize_messages` | boolean | false | Colorize messages |
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
475 476 477 478 479 480 481 482 483

### Delete Irker (IRC gateway) service

Delete Irker (IRC gateway) service for a project.

```
DELETE /projects/:id/services/irker
```

484 485 486 487 488 489 490 491
### Get Irker (IRC gateway) service settings

Get Irker (IRC gateway) service settings for a project.

```
GET /projects/:id/services/irker
```

Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
492 493
## JIRA

494 495 496 497 498 499 500 501 502
JIRA issue tracker.

### Get JIRA service settings

Get JIRA service settings for a project.

```
GET /projects/:id/services/jira
```
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
503 504 505 506 507

### Create/Edit JIRA service

Set JIRA service for a project.

508 509
> **Notes:**
> - Starting with GitLab 8.14, `api_url`, `issues_url`, `new_issue_url` and
Evan Read's avatar
Evan Read committed
510
>   `project_url` are replaced by `project_key`, `url`. If you are using an
511
>   older version, [follow this documentation][old-jira-api].
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
512 513 514 515 516

```
PUT /projects/:id/services/jira
```

517 518 519
Parameters:

| Parameter | Type | Required | Description |
520
| --------- | ---- | -------- | ----------- |
Evan Read's avatar
Evan Read committed
521
| `url`           | string | yes | The URL to the JIRA project which is being linked to this GitLab project. For example, `https://jira.example.com`. |
522
| `project_key`   | string | yes | The short identifier for your JIRA project, all uppercase, e.g., `PROJ`. |
Robert Schilling's avatar
Robert Schilling committed
523 524
| `username`      | string | yes  | The username of the user created to be used with GitLab/JIRA. |
| `password`      | string | yes  | The password of the user created to be used with GitLab/JIRA. |
525
| `jira_issue_transition_id` | integer | no | The ID of a transition that moves issues to a closed state. You can find this number under the JIRA workflow administration (**Administration > Issues > Workflows**) by selecting **View** under **Operations** of the desired workflow of your project. The ID of each state can be found inside the parenthesis of each transition name under the **Transitions (id)** column ([see screenshot][trans]). By default, this ID is set to `2`. |
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
526 527 528

### Delete JIRA service

529
Remove all previously JIRA settings from a project.
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
530 531 532 533 534

```
DELETE /projects/:id/services/jira
```

535 536
## Kubernetes

537
Kubernetes / OpenShift integration
538

539 540 541
CAUTION: **Warning:**
Kubernetes service integration has been deprecated in GitLab 10.3. API service endpoints will continue to work as long as the Kubernetes service is active, however if the service is inactive API endpoints will automatically return a `400 Bad Request`. Read [GitLab 10.3 release post](https://about.gitlab.com/2017/12/22/gitlab-10-3-released/#kubernetes-integration-service) for more information.

542 543 544 545 546 547 548 549 550 551 552
### Create/Edit Kubernetes service

Set Kubernetes service for a project.

```
PUT /projects/:id/services/kubernetes
```

Parameters:

- `namespace` (**required**) - The Kubernetes namespace to use
Evan Read's avatar
Evan Read committed
553
- `api_url` (**required**) - The URL to the Kubernetes cluster API. For example, `https://kubernetes.example.com`
554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
- `token` (**required**) - The service token to authenticate against the Kubernetes cluster with
- `ca_pem` (optional) - A custom certificate authority bundle to verify the Kubernetes cluster with (PEM format)

### Delete Kubernetes service

Delete Kubernetes service for a project.

```
DELETE /projects/:id/services/kubernetes
```

### Get Kubernetes service settings

Get Kubernetes service settings for a project.

```
GET /projects/:id/services/kubernetes
```

573
## Slack slash commands
574

575
Ability to receive slash commands from a Slack chat instance.
576

577
### Get Slack slash command service settings
578

579
Get Slack slash command service settings for a project.
580 581

```
582 583 584 585 586 587 588 589 590 591 592 593 594 595
GET /projects/:id/services/slack-slash-commands
```

Example response:

```json
{
  "id": 4,
  "title": "Slack slash commands",
  "created_at": "2017-06-27T05:51:39-07:00",
  "updated_at": "2017-06-27T05:51:39-07:00",
  "active": true,
  "push_events": true,
  "issues_events": true,
596
  "confidential_issues_events": true,
597 598 599
  "merge_requests_events": true,
  "tag_push_events": true,
  "note_events": true,
600
  "job_events": true,
601 602
  "pipeline_events": true,
  "properties": {
603
    "token": "<your_access_token>"
604 605 606 607 608 609 610 611 612 613
  }
}
```

### Create/Edit Slack slash command service

Set Slack slash command for a project.

```
PUT /projects/:id/services/slack-slash-commands
614 615 616 617
```

Parameters:

618
| Parameter | Type | Required | Description |
619
| --------- | ---- | -------- | ----------- |
620
| `token` | string | yes | The Slack token |
621

622
### Delete Slack slash command service
623

624
Delete Slack slash command service for a project.
625 626

```
627
DELETE /projects/:id/services/slack-slash-commands
628 629
```

630 631 632 633 634
## Mattermost slash commands

Ability to receive slash commands from a Mattermost chat instance.

### Get Mattermost slash command service settings
635

636
Get Mattermost slash command service settings for a project.
637 638 639 640 641

```
GET /projects/:id/services/mattermost-slash-commands
```

642 643 644 645 646 647 648 649 650 651
### Create/Edit Mattermost slash command service

Set Mattermost slash command for a project.

```
PUT /projects/:id/services/mattermost-slash-commands
```

Parameters:

652
| Parameter | Type | Required | Description |
653 654
| --------- | ---- | -------- | ----------- |
| `token` | string | yes | The Mattermost token |
655
| `username` | string | no | The username to use to post the message |
656 657 658 659 660 661 662 663 664

### Delete Mattermost slash command service

Delete Mattermost slash command service for a project.

```
DELETE /projects/:id/services/mattermost-slash-commands
```

665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698
## Packagist

Update your project on Packagist, the main Composer repository, when commits or tags are pushed to GitLab.

### Create/Edit Packagist service

Set Packagist service for a project.

```
PUT /projects/:id/services/packagist
```

Parameters:

- `username` (**required**)
- `token` (**required**)
- `server` (optional)

### Delete Packagist service

Delete Packagist service for a project.

```
DELETE /projects/:id/services/packagist
```

### Get Packagist service settings

Get Packagist service settings for a project.

```
GET /projects/:id/services/packagist
```

699 700 701 702 703 704 705 706 707 708 709 710 711 712
## Pipeline-Emails

Get emails for GitLab CI pipelines.

### Create/Edit Pipeline-Emails service

Set Pipeline-Emails service for a project.

```
PUT /projects/:id/services/pipelines-email
```

Parameters:

713
| Parameter | Type | Required | Description |
714 715 716
| --------- | ---- | -------- | ----------- |
| `recipients` | string | yes | Comma-separated list of recipient email addresses |
| `add_pusher` | boolean | no | Add pusher to recipients list |
717
| `notify_only_broken_pipelines` | boolean | no | Notify only broken pipelines |
718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734

### Delete Pipeline-Emails service

Delete Pipeline-Emails service for a project.

```
DELETE /projects/:id/services/pipelines-email
```

### Get Pipeline-Emails service settings

Get Pipeline-Emails service settings for a project.

```
GET /projects/:id/services/pipelines-email
```

Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
735 736 737 738 739 740 741 742 743 744 745 746 747 748
## PivotalTracker

Project Management Software (Source Commits Endpoint)

### Create/Edit PivotalTracker service

Set PivotalTracker service for a project.

```
PUT /projects/:id/services/pivotaltracker
```

Parameters:

749 750 751 752
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `token` | string | true | The PivotalTracker token |
| `restrict_to_branch` | boolean | false | Comma-separated list of branches which will be automatically inspected. Leave blank to include all branches. |
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
753 754 755 756 757 758 759 760 761

### Delete PivotalTracker service

Delete PivotalTracker service for a project.

```
DELETE /projects/:id/services/pivotaltracker
```

762 763 764 765 766 767 768 769
### Get PivotalTracker service settings

Get PivotalTracker service settings for a project.

```
GET /projects/:id/services/pivotaltracker
```

770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
## Prometheus

Prometheus is a powerful time-series monitoring service.

### Create/Edit Prometheus service

Set Prometheus service for a project.

```
PUT /projects/:id/services/prometheus
```

Parameters:

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
Evan Read's avatar
Evan Read committed
786
| `api_url` | string | true | Prometheus API Base URL. For example, `http://prometheus.example.com/`. |
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803

### Delete Prometheus service

Delete Prometheus service for a project.

```
DELETE /projects/:id/services/prometheus
```

### Get Prometheus service settings

Get Prometheus service settings for a project.

```
GET /projects/:id/services/prometheus
```

Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
804 805 806 807 808 809 810 811 812 813 814 815 816 817
## Pushover

Pushover makes it easy to get real-time notifications on your Android device, iPhone, iPad, and Desktop.

### Create/Edit Pushover service

Set Pushover service for a project.

```
PUT /projects/:id/services/pushover
```

Parameters:

818 819 820 821 822 823 824
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `api_key` | string | true | Your application key |
| `user_key` | string | true | Your user key |
| `priority` | string | true | The priority |
| `device` | string | false | Leave blank for all active devices |
| `sound` | string | false | The sound of the notification |
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
825 826 827 828 829 830 831 832 833

### Delete Pushover service

Delete Pushover service for a project.

```
DELETE /projects/:id/services/pushover
```

834 835 836 837 838 839 840 841
### Get Pushover service settings

Get Pushover service settings for a project.

```
GET /projects/:id/services/pushover
```

Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
842 843 844 845 846 847 848 849 850 851 852 853 854 855
## Redmine

Redmine issue tracker

### Create/Edit Redmine service

Set Redmine service for a project.

```
PUT /projects/:id/services/redmine
```

Parameters:

856 857 858 859 860 861
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `new_issue_url` | string | true | New Issue url |
| `project_url` | string | true | Project url |
| `issues_url` | string | true | Issue url |
| `description` | string | false | Description |
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
862 863 864 865 866 867 868 869 870

### Delete Redmine service

Delete Redmine service for a project.

```
DELETE /projects/:id/services/redmine
```

871 872 873 874 875 876 877 878
### Get Redmine service settings

Get Redmine service settings for a project.

```
GET /projects/:id/services/redmine
```

879
## Slack notifications
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
880

881
Receive event notifications in Slack
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
882 883 884 885 886 887 888 889 890

### Create/Edit Slack service

Set Slack service for a project.

```
PUT /projects/:id/services/slack
```

891 892
>**Note:** Specific event parameters (e.g. `push_events` flag and `push_channel`) were [introduced in v10.4][11435]

893
Parameters:
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
894

895 896
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
Evan Read's avatar
Evan Read committed
897
| `webhook` | string | true | `https://hooks.slack.com/services/...` |
898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917
| `username` | string | false | username |
| `channel` | string | false | Default channel to use if others are not configured |
| `notify_only_broken_pipelines` | boolean | false | Send notifications for broken pipelines |
| `notify_only_default_branch` | boolean | false | Send notifications only for the default branch |
| `push_events` | boolean | false | Enable notifications for push events |
| `issues_events` | boolean | false | Enable notifications for issue events |
| `confidential_issues_events` | boolean | false | Enable notifications for confidential issue events |
| `merge_requests_events` | boolean | false | Enable notifications for merge request events |
| `tag_push_events` | boolean | false | Enable notifications for tag push events |
| `note_events` | boolean | false | Enable notifications for note events |
| `pipeline_events` | boolean | false | Enable notifications for pipeline events |
| `wiki_page_events` | boolean | false | Enable notifications for wiki page events |
| `push_channel` | string | false | The name of the channel to receive push events notifications |
| `issue_channel` | string | false | The name of the channel to receive issues events notifications |
| `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 |
| `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 |
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
918 919 920 921 922 923 924 925 926

### Delete Slack service

Delete Slack service for a project.

```
DELETE /projects/:id/services/slack
```

927 928 929 930 931 932 933 934
### Get Slack service settings

Get Slack service settings for a project.

```
GET /projects/:id/services/slack
```

935 936 937 938 939 940 941 942 943
## Microsoft Teams

Group Chat Software

### Create/Edit Microsoft Teams service

Set Microsoft Teams service for a project.

```
944
PUT /projects/:id/services/microsoft-teams
945 946 947 948 949 950
```

Parameters:

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
Evan Read's avatar
Evan Read committed
951
| `webhook` | string | true | The Microsoft Teams webhook. For example, `https://outlook.office.com/webhook/...` |
952 953 954 955 956 957

### Delete Microsoft Teams service

Delete Microsoft Teams service for a project.

```
958
DELETE /projects/:id/services/microsoft-teams
959 960 961 962 963 964 965
```

### Get Microsoft Teams service settings

Get Microsoft Teams service settings for a project.

```
966
GET /projects/:id/services/microsoft-teams
967 968
```

969 970 971 972 973 974 975 976 977 978 979 980
## Mattermost notifications

Receive event notifications in Mattermost

### Create/Edit Mattermost notifications service

Set Mattermost service for a project.

```
PUT /projects/:id/services/mattermost
```

981
>**Note:** Specific event parameters (e.g. `push_events` flag and `push_channel`) were [introduced in v10.4][11435]
982

983
Parameters:
984 985 986

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
Evan Read's avatar
Evan Read committed
987
| `webhook` | string | true | The Mattermost webhook. For example, `http://mattermost_host/hooks/...` |
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
| `username` | string | false | username |
| `channel` | string | false | Default channel to use if others are not configured |
| `notify_only_broken_pipelines` | boolean | false | Send notifications for broken pipelines |
| `notify_only_default_branch` | boolean | false | Send notifications only for the default branch |
| `push_events` | boolean | false | Enable notifications for push events |
| `issues_events` | boolean | false | Enable notifications for issue events |
| `confidential_issues_events` | boolean | false | Enable notifications for confidential issue events |
| `merge_requests_events` | boolean | false | Enable notifications for merge request events |
| `tag_push_events` | boolean | false | Enable notifications for tag push events |
| `note_events` | boolean | false | Enable notifications for note events |
| `pipeline_events` | boolean | false | Enable notifications for pipeline events |
| `wiki_page_events` | boolean | false | Enable notifications for wiki page events |
| `push_channel` | string | false | The name of the channel to receive push events notifications |
| `issue_channel` | string | false | The name of the channel to receive issues events notifications |
| `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 |
| `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 |
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024

### Delete Mattermost notifications service

Delete Mattermost Notifications service for a project.

```
DELETE /projects/:id/services/mattermost
```

### Get Mattermost notifications service settings

Get Mattermost notifications service settings for a project.

```
GET /projects/:id/services/mattermost
```

Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
## JetBrains TeamCity CI

A continuous integration and build server

### Create/Edit JetBrains TeamCity CI service

Set JetBrains TeamCity CI service for a project.

> The build configuration in Teamcity must use the build format number %build.vcs.number% you will also want to configure monitoring of all branches so merge requests build, that setting is in the vsc root advanced settings.

```
PUT /projects/:id/services/teamcity
```

Parameters:

1041 1042
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
Evan Read's avatar
Evan Read committed
1043
| `teamcity_url` | string | true | TeamCity root URL. For example, `https://teamcity.example.com` |
1044 1045 1046
| `build_type` | string | true | Build configuration ID |
| `username` | string | true | A user with permissions to trigger a manual build |
| `password` | string | true | The password of the user |
Kirilll Zaitsev's avatar
Kirilll Zaitsev committed
1047 1048 1049 1050 1051 1052 1053 1054 1055

### Delete JetBrains TeamCity CI service

Delete JetBrains TeamCity CI service for a project.

```
DELETE /projects/:id/services/teamcity
```

1056 1057 1058 1059 1060 1061 1062
### Get JetBrains TeamCity CI service settings

Get JetBrains TeamCity CI service settings for a project.

```
GET /projects/:id/services/teamcity
```
1063

1064
[jira-doc]: ../user/project/integrations/jira.md
1065
[old-jira-api]: https://gitlab.com/gitlab-org/gitlab-ce/blob/8-13-stable/doc/api/services.md#jira
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082

## MockCI

Mock an external CI. See [`gitlab-org/gitlab-mock-ci-service`](https://gitlab.com/gitlab-org/gitlab-mock-ci-service) for an example of a companion mock service.

This service is only available when your environment is set to development.

### Create/Edit MockCI service

Set MockCI service for a project.

```
PUT /projects/:id/services/mock-ci
```

Parameters:

1083 1084
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
Evan Read's avatar
Evan Read committed
1085
| `mock_service_url` | string | true | `http://localhost:4004` |
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101

### Delete MockCI service

Delete MockCI service for a project.

```
DELETE /projects/:id/services/mock-ci
```

### Get MockCI service settings

Get MockCI service settings for a project.

```
GET /projects/:id/services/mock-ci
```
1102 1103

[11435]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/11435