Skip to navigation

Ticket Notification Schedule

View as Markdown

tool.ticket.notification.schedule

  • Endpoint: /tool/ticket/notification/schedule | 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/scheduleGet ticket notification schedule
PATCH/tool/ticket/notification/scheduleUpdate ticket notification schedule

Fields

FieldTypeRequiredNotes
business_start_hourintegerHour, in local time, when notifications may start being sent each day, e.g. 9.
business_end_hourintegerHour, in local time, after which notifications stop being sent each day, e.g. 18.
respect_user_timezone_dslstringMoveworks DSL rule that, when it matches, uses the user’s timezone instead of Pacific time for ticket notifications.
weekend_notifications_enabled_dslstringMoveworks DSL rule that, when it matches, allows ticket notifications on weekends during business hours.
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.

{
"business_start_hour": 1,
"business_end_hour": 1,
"respect_user_timezone_dsl": "true",
"weekend_notifications_enabled_dsl": "true"
}