Skip to navigation

Ticket Destination Mappers

View as Markdown

tool.ticket.integration.destination-mappers

A ticket destination mapper converts raw tickets from a ticketing system into a ticket destination. There is at most one per ticketing connector.

  • Endpoint: /tool/ticket/integration/destination-mappers | 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.

MethodPathEndpoint reference
GET/tool/ticket/integration/destination-mappersList ticket destination mappers
POST/tool/ticket/integration/destination-mappersCreate ticket destination mapper
GET/tool/ticket/integration/destination-mappers/{id}Get ticket destination mapper
PATCH/tool/ticket/integration/destination-mappers/{id}Update ticket destination mapper

Fields

FieldTypeRequiredNotes
idstringread-onlyUnique ID of this configuration, assigned by the server.
connector_idstring✅Connector for the ticketing system whose tickets this mapper reads. Cannot be changed after creation. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).
mapper_benderobjectData mapping, in Moveworks data mapper JSON, that converts a raw ticket into its ticket destination.
destination_field_mappingsarray<TicketDestinationFieldMappingSettings>Ticket destination fields and the raw ticket fields that feed them. Needed only for ManageEngine.
updated_timestringread-onlyWhen the configuration was last updated.
updated_bystringread-onlyWho last updated the configuration.
versionVersion✅Document version. On update, send back the num from your last read.

Example create body

{
"connector_id": "<connector-uuid>",
"version": {
"change_description": "Initial version."
}
}