Skip to navigation

Ticket Nudges

View as Markdown

tool.ticket.nudge

  • Endpoint: /tool/ticket/nudge | 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/nudgeGet ticket nudges
PATCH/tool/ticket/nudgeUpdate ticket nudges

Fields

FieldTypeRequiredNotes
max_nudge_count_for_ticketintegerMaximum number of times a user can be nudged about an inactive ticket. Must be greater than 0.
nudge_interval_start_offset_daysintegerStart of the window, in days since the ticket was last updated, in which tickets are eligible for nudges.
nudge_interval_end_offset_daysintegerEnd of the window, in days since the ticket was last updated, in which tickets are eligible for nudges.
nudge_inactivity_threshold_daysintegerNumber of days without a new comment before a ticket is eligible for a nudge.
nudge_reminder_threshold_daysintegerMinimum number of days between nudges for the same ticket.
nudge_reminders_enabled_dslstringMoveworks DSL rule that turns on in-bot nudge reminders for matching users who drop off.
nudge_poller_enabledbooleanIf true, Moveworks polls for tickets that need nudge notifications.
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.

{
"max_nudge_count_for_ticket": 1,
"nudge_interval_start_offset_days": 1,
"nudge_interval_end_offset_days": 1,
"nudge_inactivity_threshold_days": 1,
"nudge_reminder_threshold_days": 1,
"nudge_reminders_enabled_dsl": "true",
"nudge_poller_enabled": true
}