Skip to navigation

Create ticket integration setting

View as Markdown

Creates a ticket integration setting and returns it with its server-assigned id and version.

Send the fields at the top level of the body. Don’t send id or version.num; version.change_description is required.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Request

This endpoint expects an object.
connector_idstringRequiredformat: "uuid">=1 character

Connector for the ticketing system these settings describe. Cannot be changed after creation. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).

namestringRequired>=1 character
Friendly name for this ticketing system configuration.
bot_sys_idstringRequired1-64 characters
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.
versionobjectRequired
Document version. On update, send back the num from your last read.
project_namestringOptional
Name of the project in the ticketing system, e.g. the Jira project.
primarybooleanOptional

If true, this is the primary ticketing system. Only one configuration can be primary; setting this true unsets the previous primary.

concierge_ticket_typeslist of enumsOptional

Ticket types the assistant can poll for status checks and nudges. Allowed values: INCIDENT, REQUEST, REQUEST_ITEM, CALL, TASK, MISC, UNIVERSAL_REQUEST, HR_CASE.

ticket_types_to_polllist of enumsOptional

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.

ticket_url_formatstringOptional
Redirect URL format for links users click to open a ticket in the portal.
ticket_actions_requiring_user_impersonationlist of enumsOptional

Ticket actions the bot performs by impersonating the user instead of acting on their behalf. Allowed values: ADD_COMMENT, REOPEN_TICKET, RESOLVE_TICKET.

Allowed values:
service_portal_uristringOptional

Path of the service portal in the ticketing system, used to build links to portal pages (e.g. servicedesk/customer/portal).

rtf_summary_formatstringOptional
Format of the summary used for rich ticket filing in this ticketing system.

Response

The created ticket integration setting
idstringOptionalRead-only
Unique ID of this configuration, assigned by the server.
connector_idstringOptionalformat: "uuid">=1 character

Connector for the ticketing system these settings describe. Cannot be changed after creation. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).

project_namestringOptional
Name of the project in the ticketing system, e.g. the Jira project.
namestringOptional>=1 character
Friendly name for this ticketing system configuration.
primarybooleanOptional

If true, this is the primary ticketing system. Only one configuration can be primary; setting this true unsets the previous primary.

bot_sys_idstringOptional1-64 characters
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_typeslist of enumsOptional

Ticket types the assistant can poll for status checks and nudges. Allowed values: INCIDENT, REQUEST, REQUEST_ITEM, CALL, TASK, MISC, UNIVERSAL_REQUEST, HR_CASE.

ticket_types_to_polllist of enumsOptional

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.

ticket_url_formatstringOptional
Redirect URL format for links users click to open a ticket in the portal.
ticket_actions_requiring_user_impersonationlist of enumsOptional

Ticket actions the bot performs by impersonating the user instead of acting on their behalf. Allowed values: ADD_COMMENT, REOPEN_TICKET, RESOLVE_TICKET.

Allowed values:
service_portal_uristringOptional

Path of the service portal in the ticketing system, used to build links to portal pages (e.g. servicedesk/customer/portal).

rtf_summary_formatstringOptional
Format of the summary used for rich ticket filing in this ticketing system.
updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error