GIgitlab
integrations

Create or update the Unify Circuit integration

Creates or updates the Unify Circuit integration.

put/api/v4/projects/{id}/services/unify-circuit

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Path parameters

idinteger required

Request body

webhookstring required

The Unify Circuit webhook (for example, https://circuit.com/rest/v2/webhooks/incoming/...).

notify_only_broken_pipelinesboolean

Send notifications for broken pipelines.

notify_only_when_pipeline_status_changesboolean

Send notifications only when the pipeline status changes.

branches_to_be_notifiedstring

Branches to send notifications for. Valid options are all, default, protected, and default_and_protected. The default value is default.

push_eventsboolean

Trigger event for pushes to the repository.

issues_eventsboolean

Trigger event when a work item is created, updated, or closed.

confidential_issues_eventsboolean

Trigger event when a confidential work item is created, updated, or closed.

work_item_eventsboolean
confidential_work_item_eventsboolean
merge_requests_eventsboolean

Trigger event when a merge request is created, updated, or merged.

note_eventsboolean

Trigger event for new comments.

confidential_note_eventsboolean

Trigger event for new comments on confidential work items.

tag_push_eventsboolean

Trigger event for new tags pushed to the repository.

pipeline_eventsboolean

Trigger event when a pipeline status changes.

wiki_page_eventsboolean

Trigger event when a wiki page is created or updated.

use_inherited_settingsboolean

Indicates whether to inherit the default settings. Defaults to false.

Response

Create or update the Unify Circuit integration

idinteger required
titlestring required
slugstring required
created_atstring date-time required
updated_atstring date-time required
activeboolean required
commit_eventsboolean required
push_eventsboolean required
issues_eventsboolean required
incident_eventsboolean required
alert_eventsboolean required
confidential_issues_eventsboolean required
merge_requests_eventsboolean required
tag_push_eventsboolean required
deployment_eventsboolean required
note_eventsboolean required
confidential_note_eventsboolean required
pipeline_eventsboolean required
wiki_page_eventsboolean required
job_eventsboolean required
comment_on_event_enabledboolean required
inheritedboolean required
vulnerability_eventsboolean required

Example response

{
  "id": 75,
  "title": "Jenkins CI",
  "slug": "jenkins",
  "created_at": "2019-11-20T11:20:25.297Z",
  "updated_at": "2019-11-20T12:24:37.498Z"
}

Changes

No recorded changes to this operation across all 5 revisions of this API.