Skip to navigation

Ticket Poller

View as Markdown

tool.ticket.poller

Nothing ingests until ticket_poller_enabled_dsl is truthy.

  • Endpoint: /tool/ticket/poller | 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/pollerGet ticket poller
PATCH/tool/ticket/pollerUpdate ticket poller

Fields

FieldTypeRequiredNotes
ticket_poller_enabled_dslstringMoveworks DSL rule that turns on polling of your ticketing systems for new tickets and updates.
itsm_webhook_processing_enabled_dslstringMoveworks DSL rule that turns on processing of webhook events from your ITSM system. Enable only if ticket syncing with channel resolver is configured.
poll_interval_secondsintegerHow often, in seconds, the ticketing system is polled for tickets.
maximum_look_back_secondsintegerMaximum age, in seconds, of tickets polled, which limits how far behind the current time polling can fall. Between 30 and 600.
grace_period_secondsintegerHow far, in seconds, polling stays behind the current time to allow for delays in the ticketing system’s data. Between 10 and 600.
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.

{
"ticket_poller_enabled_dsl": "true",
"itsm_webhook_processing_enabled_dsl": "true",
"poll_interval_seconds": 60,
"maximum_look_back_seconds": 60,
"grace_period_seconds": 60
}