Skip to navigation

API Reference & Tools Overview

View as Markdown

API Reference & Tools

Moveworks provides REST APIs to integrate AI-powered automation into your applications and workflows. This area also covers the configuration languages used throughout the platform (DSL rules and Data Mappers) and the tools and resources for building and testing plugins.

API Categories

Core APIs (Moveworks-hosted)

These APIs are hosted by Moveworks and allow you to send data and interact with the platform:

APIDescription
Events APISend events to trigger automations and workflows
Conversations APICreate and manage conversation threads programmatically (/rest/v1)
(Deprecated) Conversations APIDeprecated /assistant/v1 base path, superseded by /rest/v1
(Beta) Conversations APIPrevious beta version (v1beta1)
Data APIQuery and manage data within the platform
Webhook ListenersReceive webhook events from external systems

Each API has its own section in the sidebar with endpoint reference and setup guides, for example the Conversations API, Data API, and Webhook Listeners.

Gateways (Customer-hosted)

These APIs are implemented by customers to provide data to Moveworks:

GatewayDescription
Content GatewayServe content and documents to the AI
Identity GatewayResolve user identities across systems
Knowledge GatewayProvide knowledge base search results
Forms GatewayHandle form submissions and data collection

Authentication

The Moveworks-hosted Events API, Data API, and Webhook Listeners authenticate with a static API key sent as a Bearer token in the Authorization header. The Conversations API instead mints a per-user token through an OAuth token exchange; see the Conversations API overview. The customer-hosted gateways are authenticated in the other direction, with Moveworks calling your endpoint; see Content Gateway authentication.

curl -X GET "https://api.moveworks.ai/rest/v1/conversations" \
  -H "Authorization: Bearer YOUR_API_KEY"

Base URLs

The Moveworks API is hosted per data center. Every API request must go to the base URL for the data center your org is on. https://api.moveworks.ai only serves US Production. Sending requests to the wrong host fails authentication even if your token is otherwise valid, because credentials are registered per data center.

Data CenterBase URL
United States (default)https://api.moveworks.ai
Canadahttps://api.am-ca-central.moveworks.ai
EUhttps://api.am-eu-central.moveworks.ai
Australia / Asia Pacifichttps://api.am-ap-southeast.moveworks.ai
Government Secure Cloudhttps://api.moveworksgov.ai
Japanhttps://api.jp.moveworks.com
UKhttps://api.uk.moveworks.com
US Prod 4https://api.prod4.us.moveworks.com
US Prod 3https://api.prod3.us.moveworks.com

If you’re not sure which data center your org is on, or your org is on a data center not listed above, contact your Moveworks account team for the correct base URL before making API calls.

Rate Limits

API requests are rate limited to ensure platform stability. Contact support for rate limit increases.

Configuration Languages

Two small languages appear throughout Moveworks configuration. DSL rules express business logic as expressions that evaluate against Moveworks data objects such as User and Ticket, or against JSON from an external system, and are used in launch rules, Setup fields, plugin configuration, and connectors. Data Mappers (also called Bender) transform JSON payloads, extracting, reshaping, and formatting data as it moves between systems. Test either one in the playground before applying it.

DSL and Mapper Playground

Evaluate a DSL expression or Data Mapper against a sample payload inside Moveworks Setup, with a visual rule builder and a searchable function reference. No API key required.

Common DSL & Mapper Patterns

Recipes for the patterns that come up most in real builds, starting with how string constants work in YAML.

DSL Reference

Operators, syntax, and precedence for DSL rules, with common examples and rule scenarios for plugins.

Data Mapper Reference

The operators and functions of the data mapping language, with common examples.

DSL Builder & Evaluator

Create, modify, and test the DSL rules used across Moveworks, including context-dependent expressions that need an ingested user.

Custom Attributes

Register attributes beyond the defaults on User, Ticket, Approvals, and Knowledge, and reference them in DSL rules.

Data Dictionary

The Moveworks data objects that rules and mappers evaluate against: User, Ticket, TicketGatewayContext, Handoff, Domain, ApprovableEntity, Group, and DocSource.

Tools & Resources

AI Agent Marketplace

Over 100 pre-built plugins for IT, HR, sales, finance, and other functions that you can browse, install, and configure for your tenant.

Developer Tools

ToolSmith, Purple Chat, the Purple API tool, the DSL & Mapper Playground, Message Tester, and API Mocker.

Moveworks on GitHub

The Moveworks organization on GitHub.

Within the Marketplace, Installing AI Agents walks through the install flow, and Initiative Designer lets you discover and customize end-to-end business processes before you build. For a mock backend of enterprise systems to build and test against, follow Purple Suite Setup.

Also in This Area