UPuptime
integrations

POST /api/v1/integrations/add-servicenow/

Create a new ServiceNow 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
instance_urlstring uri

The base URL of your ServiceNow instance, e.g. "https://your-instance.service-now.com"

usernamestring

User ID of the ServiceNow service account used by this integration.

passwordstring

Password of the ServiceNow service account.

urgency'' | '1' | '2' | '3'

Urgency to assign to incidents created by this integration.

impact'' | '1' | '2' | '3'

Impact to assign to incidents created by this integration.

assignment_groupstring

Name or sys_id of the group incidents should be assigned to.

close_codestring

Resolution code applied when auto-resolving an incident. Must match one of the resolution codes configured on your instance.

autoresolveboolean

Automatically resolve the incident once the check is back up.

include_payloadboolean

Attach the complete alert details as JSON to the incident's Work notes, so they are available to reports, flows and business rules on your instance.

custom_fields_jsonstring
<div class="dropdown"> Advanced configuration for additional incident fields, built-in or custom, using JSON format. Any <code>$reference</code> within a value is replaced with the matching value from the alert. A mapped <code>assignment_group</code> is looked up the same way as the dedicated Assignment Group setting above, so a group name works here too, not just a sys_id. Other reference fields, such as <code>business_service</code>, <code>service_offering</code> and <code>cmdb_ci</code>, are not looked up this way and need their target record's sys_id, not its display name. 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> { "category": "Application", "subcategory": "Error Message", "business_service": "c4ca4238a0b923820dcc509a6f75849", "service_offering": "c81e728d9d4c2f636f067f89cc14862c", "cmdb_ci": "eccbc87e4b5ce2fe28308fd9f2a7baf3", "contact_type": "Monitoring", "assignment_group": "Monitoring System-L2", "u_check_name": "$service.display_name", "u_check_url": "$service.msp_address", "u_check_type": "$service.monitoring_service_type_display", "u_check_tags": "$service.tags", "u_locations_down": "$global_alert_state.num_locations_down", "u_failing_locations": "$locations", "u_alert_output": "$alert.short_output", "u_account_name": "$account.name", "u_monitoring_tool": "Uptime.com", "u_summary": "$service.display_name is down ($service.msp_address)" } </code></pre> </div> </div>

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
instance_urlstring uri

The base URL of your ServiceNow instance, e.g. "https://your-instance.service-now.com"

usernamestring

User ID of the ServiceNow service account used by this integration.

passwordstring

Password of the ServiceNow service account.

urgency'' | '1' | '2' | '3'

Urgency to assign to incidents created by this integration.

impact'' | '1' | '2' | '3'

Impact to assign to incidents created by this integration.

assignment_groupstring

Name or sys_id of the group incidents should be assigned to.

close_codestring

Resolution code applied when auto-resolving an incident. Must match one of the resolution codes configured on your instance.

autoresolveboolean

Automatically resolve the incident once the check is back up.

include_payloadboolean

Attach the complete alert details as JSON to the incident's Work notes, so they are available to reports, flows and business rules on your instance.

custom_fields_jsonstring
<div class="dropdown"> Advanced configuration for additional incident fields, built-in or custom, using JSON format. Any <code>$reference</code> within a value is replaced with the matching value from the alert. A mapped <code>assignment_group</code> is looked up the same way as the dedicated Assignment Group setting above, so a group name works here too, not just a sys_id. Other reference fields, such as <code>business_service</code>, <code>service_offering</code> and <code>cmdb_ci</code>, are not looked up this way and need their target record's sys_id, not its display name. 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> { "category": "Application", "subcategory": "Error Message", "business_service": "c4ca4238a0b923820dcc509a6f75849", "service_offering": "c81e728d9d4c2f636f067f89cc14862c", "cmdb_ci": "eccbc87e4b5ce2fe28308fd9f2a7baf3", "contact_type": "Monitoring", "assignment_group": "Monitoring System-L2", "u_check_name": "$service.display_name", "u_check_url": "$service.msp_address", "u_check_type": "$service.monitoring_service_type_display", "u_check_tags": "$service.tags", "u_locations_down": "$global_alert_state.num_locations_down", "u_failing_locations": "$locations", "u_alert_output": "$alert.short_output", "u_account_name": "$account.name", "u_monitoring_tool": "Uptime.com", "u_summary": "$service.display_name is down ($service.msp_address)" } </code></pre> </div> </div>

Changes

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