Skip to navigation

Ticket Notification Settings

View as Markdown

tool.ticket.notification.setting

  • Endpoint: /tool/ticket/notification/setting | Methods: GET, PATCH
  • Request shape: one per organization, so there is no id. It already exists: read it with GET, then PATCH the fields you want to change. Fields go at the top level of the JSON body, with no resource wrapper.
  • 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/notification/settingGet ticket notification settings
PATCH/tool/ticket/notification/settingUpdate ticket notification settings

Fields

FieldTypeRequiredNotes
watcher_ticket_filter_dslstringMoveworks DSL rule defining which tickets are eligible for notifications to ticket watchers.
ticket_update_notification_work_notes_enabledbooleanIf true, a work note is added to the ticket for each ticket update notification sent to a user.
ticket_close_notificationTicketCloseNotificationSettingsWhich ticket state triggers closed-ticket notifications, with optional overrides per ticket type.
watcher_notifications_disabled_dslstringMoveworks DSL rule that, when it matches, stops ticket notifications from being sent to watchers.
user_notifiable_dslstringMoveworks DSL rule defining which users the assistant may send ticket notifications to for state changes and comments.
watcher_close_disabled_dslstringMoveworks DSL rule that, when it matches, prevents ticket watchers from resolving tickets.
business_hours_start_dslstringMoveworks DSL rule giving the start of business hours, local to the user, in HH:MM 24-hour time.
business_hours_end_dslstringMoveworks DSL rule giving the end of business hours, local to the user, in HH:MM 24-hour time.
geocode_business_hours_enabled_dslstringMoveworks DSL rule that, when it matches, determines the user’s weekend days from their location instead of assuming a Monday to Friday week.
ticket_filters_in_bot_route_enabled_dslstringMoveworks DSL rule that, when it matches, also applies ticket filters when users query tickets.
tickets_visibility_restricted_dslstringMoveworks DSL rule that, when it matches, lets only a ticket’s requestor look up that ticket.
updated_timestringread-onlyWhen the configuration was last updated.
updated_bystringread-onlyWho last updated the configuration.
versionVersionDocument version. On update, send back the num from your last read.

Document fields (example)

The document as GET returns it. To change any of these, send only the fields you want to change in the PATCH body.

{
"watcher_ticket_filter_dsl": "true",
"ticket_update_notification_work_notes_enabled": true,
"ticket_close_notification": {
"default_state_for_notification": "CLOSED",
"close_notification_overrides": [
{
"ticket_type": "DEFAULT",
"ticket_close_state": "CLOSED",
"item_ref": "<string>"
}
]
},
"watcher_notifications_disabled_dsl": "true",
"user_notifiable_dsl": "true",
"watcher_close_disabled_dsl": "true",
"business_hours_start_dsl": "true",
"business_hours_end_dsl": "true"
}