UPuptime
integrations

POST /api/v1/integrations/add-jiraservicedesk/

Create a new Jira Service Desk integration

Request

Request body

pkinteger
urlstring
namestring required

Your preferred name for this integration.

modulestring

The provider of the integration.

contact_groupsstring[]

Array of contact names or IDs this integration is assigned to

is_erroredboolean
last_errorstring
api_emailstring

Email of the user whose API token is being used.

api_tokenstring

API Token created for the user, or the user's password (self-hosted only).

jira_subdomainstring uri

The domain your company uses to access Jira, e.g. "https://your-domain.atlassian.net"

project_keystring

The project key of your Service Desk project, shown on the Project Settings > Details page. E.g. "SMPSRVDESK"

labelsstring

A comma separated list of labels attached to each incident created. The "Uptime.com" label any associated check tags are always set.

custom_field_id_account_nameinteger

An optional ID for a custom text field that should receive the account name.

custom_field_id_check_nameinteger

An optional ID for a custom text field that should receive the check name.

custom_field_id_check_urlinteger

An optional ID for a custom text field that should receive the check URL.

custom_fields_jsonstring
<div class="dropdown"> Advanced configuration for custom fields using JSON format. See <a href="#" role="button" id="dropdownMenuLink" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">example values</a>. <div class="dropdown-menu border dark-shadow" style="width: 37rem;" aria-labelledby="dropdownMenuLink"> <pre><code> { "customfield_10000": "this is a text field", "customfield_20000": "this is a multi-line text field. big text.", "customfield_30000": "2011-07-13T15:25:00", "customfield_40000": { "value": "this is a select list value" }, "customfield_50000": { "name": "this is a group picker value" }, "customfield_60000": [ {"value": "this is a multi select list value #1"}, {"value": "this is a multi select list value #2"} ], } </code></pre> </div> </div>
alert_resolved_labelstring

When you fill in this field, a label will be added to the Jira issue once the Alert is resolved. Note: Spaces are not supported.

Response

pkinteger
urlstring
namestring required

Your preferred name for this integration.

modulestring

The provider of the integration.

contact_groupsstring[]

Array of contact names or IDs this integration is assigned to

is_erroredboolean
last_errorstring
api_emailstring

Email of the user whose API token is being used.

api_tokenstring

API Token created for the user, or the user's password (self-hosted only).

jira_subdomainstring uri

The domain your company uses to access Jira, e.g. "https://your-domain.atlassian.net"

project_keystring

The project key of your Service Desk project, shown on the Project Settings > Details page. E.g. "SMPSRVDESK"

labelsstring

A comma separated list of labels attached to each incident created. The "Uptime.com" label any associated check tags are always set.

custom_field_id_account_nameinteger

An optional ID for a custom text field that should receive the account name.

custom_field_id_check_nameinteger

An optional ID for a custom text field that should receive the check name.

custom_field_id_check_urlinteger

An optional ID for a custom text field that should receive the check URL.

custom_fields_jsonstring
<div class="dropdown"> Advanced configuration for custom fields using JSON format. See <a href="#" role="button" id="dropdownMenuLink" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">example values</a>. <div class="dropdown-menu border dark-shadow" style="width: 37rem;" aria-labelledby="dropdownMenuLink"> <pre><code> { "customfield_10000": "this is a text field", "customfield_20000": "this is a multi-line text field. big text.", "customfield_30000": "2011-07-13T15:25:00", "customfield_40000": { "value": "this is a select list value" }, "customfield_50000": { "name": "this is a group picker value" }, "customfield_60000": [ {"value": "this is a multi select list value #1"}, {"value": "this is a multi select list value #2"} ], } </code></pre> </div> </div>
alert_resolved_labelstring

When you fill in this field, a label will be added to the Jira issue once the Alert is resolved. Note: Spaces are not supported.

Changes

No recorded changes to this operation across all 1 revision of this API.