> This page is for API Reference & Tools.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.moveworks.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.moveworks.com/_mcp/server.

# Ticket Integration Settings

> Create, read and update Ticket Integration Settings through the Moveworks Configuration API: endpoints, fields and examples.

`tool.ticket.integration.settings`

The anchor record: registers one ITSM system. `bot_sys_id` must match the bot's identity in `identity-bot-account.itsm_id_info` for this connector.

* **Endpoint:** `/tool/ticket/integration/settings`  |  **Methods:** GET, PATCH, POST
* **Request shape:** fields go at the top level of the JSON body, with no `resource` wrapper. The item's `id` goes in the URL for reads and updates, not in the body.
* **Updates:** a JSON merge-patch. Send only the fields you change, plus `version: {num, change_description}` with the `num` from your last read. Lists and maps you send replace the stored ones whole.

### Endpoints

All paths are relative to `https://api.moveworks.ai/configurations/v1alpha1`. Each endpoint page lists the request and response schema, an example, and the errors it can return.

| Method  | Path                                     | Endpoint reference                                                                                                                            |
| ------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `GET`   | `/tool/ticket/integration/settings`      | [List ticket integration settings](/api-reference/configuration-api/ticketing/ticket-integration-settings/list-ticket-integration-settings)   |
| `POST`  | `/tool/ticket/integration/settings`      | [Create ticket integration setting](/api-reference/configuration-api/ticketing/ticket-integration-settings/create-ticket-integration-setting) |
| `GET`   | `/tool/ticket/integration/settings/{id}` | [Get ticket integration setting](/api-reference/configuration-api/ticketing/ticket-integration-settings/get-ticket-integration-setting)       |
| `PATCH` | `/tool/ticket/integration/settings/{id}` | [Update ticket integration setting](/api-reference/configuration-api/ticketing/ticket-integration-settings/update-ticket-integration-setting) |

### Fields

| Field                                         | Type                             | Required  | Notes                                                                                                                                                                                                                                                                                                                        |
| --------------------------------------------- | -------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`                                          | string                           | read-only | Unique ID of this configuration, assigned by the server.                                                                                                                                                                                                                                                                     |
| `connector_id`                                | string                           | ✅         | Connector for the ticketing system these settings describe. Cannot be changed after creation. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).                                                                                                                                                |
| `project_name`                                | string                           |           | Name of the project in the ticketing system, e.g. the Jira project.                                                                                                                                                                                                                                                          |
| `name`                                        | string                           | ✅         | Friendly name for this ticketing system configuration.                                                                                                                                                                                                                                                                       |
| `primary`                                     | boolean                          |           | If true, this is the primary ticketing system. Only one configuration can be primary; setting this true unsets the previous primary.                                                                                                                                                                                         |
| `bot_sys_id`                                  | string                           | ✅         | ID of the Moveworks bot service account in the ticketing system. Must match the external ID or ITSM user ID configured for that account in your identity settings. 1 to 64 characters.                                                                                                                                       |
| `concierge_ticket_types`                      | array\<enum>                     |           | Ticket types the assistant can poll for status checks and nudges. Allowed values: INCIDENT, REQUEST, REQUEST_ITEM, CALL, TASK, MISC, UNIVERSAL_REQUEST, HR_CASE. One of: `INCIDENT`, `REQUEST`, `REQUEST_ITEM`, `CALL`, `TASK`, `MISC`, `UNIVERSAL_REQUEST`, `HR_CASE`.                                                      |
| `ticket_types_to_poll`                        | array\<enum>                     |           | Ticket types polled so that assistant skills such as status checks, access requests, forms and triage can act on them. Allowed values: INCIDENT, REQUEST, REQUEST_ITEM, CALL, TASK, MISC, UNIVERSAL_REQUEST, HR_CASE. One of: `INCIDENT`, `REQUEST`, `REQUEST_ITEM`, `CALL`, `TASK`, `MISC`, `UNIVERSAL_REQUEST`, `HR_CASE`. |
| `ticket_url_format`                           | string                           |           | Redirect URL format for links users click to open a ticket in the portal.                                                                                                                                                                                                                                                    |
| `ticket_actions_requiring_user_impersonation` | array\<enum>                     |           | Ticket actions the bot performs by impersonating the user instead of acting on their behalf. Allowed values: ADD_COMMENT, REOPEN_TICKET, RESOLVE_TICKET. One of: `ADD_COMMENT`, `REOPEN_TICKET`, `RESOLVE_TICKET`.                                                                                                           |
| `service_portal_uri`                          | string                           |           | Path of the service portal in the ticketing system, used to build links to portal pages (e.g. servicedesk/customer/portal).                                                                                                                                                                                                  |
| `service_portal_links`                        | TicketServicePortalLinksSettings |           | Links to service portal pages shown to users.                                                                                                                                                                                                                                                                                |
| `rtf_summary_format`                          | string                           |           | Format of the summary used for rich ticket filing in this ticketing system.                                                                                                                                                                                                                                                  |
| `updated_time`                                | string                           | read-only | When the configuration was last updated.                                                                                                                                                                                                                                                                                     |
| `updated_by`                                  | string                           | read-only | Who last updated the configuration.                                                                                                                                                                                                                                                                                          |
| `version`                                     | Version                          | ✅         | Document version. On update, send back the num from your last read.                                                                                                                                                                                                                                                          |

### Example create body

```json
{
  "connector_id": "<connector-uuid>",
  "project_name": "example-name",
  "name": "example-name",
  "primary": true,
  "bot_sys_id": "<id>",
  "concierge_ticket_types": [],
  "ticket_types_to_poll": [],
  "ticket_url_format": "https://example.com/path",
  "ticket_actions_requiring_user_impersonation": [],
  "service_portal_uri": "https://example.com/path",
  "service_portal_links": {
    "all_tickets_url": "https://example.com/path"
  },
  "version": {
    "change_description": "Create ticket integration setting"
  }
}
```