Skip to content

Create or update the Unify Circuit integration

PUT
/api/v4/projects/{id}/integrations/unify-circuit

Creates or updates the Unify Circuit integration.

id
required
One of:
string

The ID or URL-encoded path of the project

Example
1
Media type application/json
object
webhook
required

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

string
nullable
notify_only_broken_pipelines

Send notifications for broken pipelines.

boolean
nullable
notify_only_when_pipeline_status_changes

Send notifications only when the pipeline status changes.

boolean
nullable
branches_to_be_notified

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

string
nullable
push_events

Trigger event for pushes to the repository.

boolean
nullable
issues_events

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

boolean
nullable
confidential_issues_events

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

boolean
nullable
work_item_events
boolean
nullable
confidential_work_item_events
boolean
nullable
merge_requests_events

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

boolean
nullable
note_events

Trigger event for new comments.

boolean
nullable
confidential_note_events

Trigger event for new comments on confidential work items.

boolean
nullable
tag_push_events

Trigger event for new tags pushed to the repository.

boolean
nullable
pipeline_events

Trigger event when a pipeline status changes.

boolean
nullable
wiki_page_events

Trigger event when a wiki page is created or updated.

boolean
nullable
use_inherited_settings

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

boolean
nullable
Example generated
{
"webhook": "example",
"notify_only_broken_pipelines": true,
"notify_only_when_pipeline_status_changes": true,
"branches_to_be_notified": "example",
"push_events": true,
"issues_events": true,
"confidential_issues_events": true,
"work_item_events": true,
"confidential_work_item_events": true,
"merge_requests_events": true,
"note_events": true,
"confidential_note_events": true,
"tag_push_events": true,
"pipeline_events": true,
"wiki_page_events": true,
"use_inherited_settings": true
}

OK

Media type application/json
object
id
integer format: int64
title
string
slug
string
created_at
string format: date-time
updated_at
string format: date-time
active
boolean
commit_events
boolean
push_events
boolean
issues_events
boolean
incident_events
boolean
alert_events
boolean
confidential_issues_events
boolean
merge_requests_events
boolean
tag_push_events
boolean
deployment_events
boolean
note_events
boolean
confidential_note_events
boolean
pipeline_events
boolean
wiki_page_events
boolean
job_events
boolean
comment_on_event_enabled
boolean
inherited
boolean
vulnerability_events
boolean
Example
{
"id": 75,
"title": "Jenkins CI",
"slug": "jenkins",
"created_at": "2019-11-20T11:20:25.297Z",
"updated_at": "2019-11-20T12:24:37.498Z"
}

Bad request

Unauthorized

Not found

Unprocessable entity