---
title: "POST /api/v1/integrations/add-servicenow/"
method: POST
path: "/api/v1/integrations/add-servicenow/"
tags: ["integrations"]
---

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

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

## Request

- Base URL: `https://uptime.com` (the document declares no server; this is the origin it was published from)
- URL: `https://uptime.com/api/v1/integrations/add-servicenow/`
- Auth: none declared
- TypeScript: <https://skmtc.dev/uptime/apis/uptime-com-openapi-schema/docs/api/v1/integrations/add-servicenow/post.ts> (a function with typed inputs; its response is checked against the schema)

Create a new ServiceNow integration

## Request body

- IntegrationServicenow
  - `pk` integer
  - `url` string
  - `name` string, required: Your preferred name for this integration.
  - `module` string: The provider of the integration.
  - `contact_groups` string[]: Array of contact names or IDs this integration is assigned to
  - `is_errored` boolean
  - `last_error` string
  - `instance_url` string, uri: The base URL of your ServiceNow instance, e.g. "https://your-instance.service-now.com"
  - `username` string: User ID of the ServiceNow service account used by this integration.
  - `password` string: 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_group` string: Name or sys_id of the group incidents should be assigned to.
  - `close_code` string: Resolution code applied when auto-resolving an incident. Must match one of the resolution codes configured on your instance.
  - `autoresolve` boolean: Automatically resolve the incident once the check is back up.
  - `include_payload` boolean: 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_json` string: <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 `200`

- IntegrationServicenow
  - `pk` integer
  - `url` string
  - `name` string, required: Your preferred name for this integration.
  - `module` string: The provider of the integration.
  - `contact_groups` string[]: Array of contact names or IDs this integration is assigned to
  - `is_errored` boolean
  - `last_error` string
  - `instance_url` string, uri: The base URL of your ServiceNow instance, e.g. "https://your-instance.service-now.com"
  - `username` string: User ID of the ServiceNow service account used by this integration.
  - `password` string: 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_group` string: Name or sys_id of the group incidents should be assigned to.
  - `close_code` string: Resolution code applied when auto-resolving an incident. Must match one of the resolution codes configured on your instance.
  - `autoresolve` boolean: Automatically resolve the incident once the check is back up.
  - `include_payload` boolean: 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_json` string: <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>

---

[API](https://skmtc.dev/uptime/apis/uptime-com-openapi-schema.md) - [All operations](https://skmtc.dev/uptime/apis/uptime-com-openapi-schema/llms.txt) - [OpenAPI document](https://skmtc.dev/uptime/apis/uptime-com-openapi-schema/revisions/e1e4a57a60d8?raw)