Moveworks Gateway

Overview

To ingest content (such as knowledge or files) from your platforms into the Moveworks Copilot, you can build APIs that follow our Content Gateway API specifications.

Gateway Architecture

Under this architecture, you just provide us APIs - we handle the data ingestion pipelines (including polling, efficient diffing, retries) and search indexing.

Getting Started

Some common tools recommended by our existing customers & technology partners include:

  • Heroku Dynos
  • AWS Lambda Functions
  • Azure Cloud Functions
  • Workato API Management Recipes

For help building your internal gateway, just ask for help from our professional services team, or download our starter code.

FAQs

Q: Can I build my own APIs that have custom endpoints and responses?

A: No, the Content Gateway approach relies on you to follow the Moveworks Gateway spec. We’ve design this Gateway spec based on best oData & API design practices.

Q: What if I have multiple backend systems?

A: You can create as many gateways as you want. Moveworks will integrate with them all. We recommend 1 gateway per instance to avoid stability issues.

Q: What if I already built a Gateway with a system and now want to build another gateway? What can I re-use?

A: Every content source system should typically be connected to a dedicated Gateway connector with new URLs & authorization. A majority of their previous gateway setup should be re-usable and you can duplicate your previous setup as a start. Only change will be when fetch content for the new gateway setup, make sure to retrieve it from the new source system.

Q: How does rate limit work?

A: Moveworks will make as many API calls as possible. You need to enforce the API rate limit on the Gateway using the Retry-After parameter for the 429 Error code.

Q: What are legacy gateways?

A: These are older gateways built on old search infrastructure. That means they may have performance issues and are harder to troubleshoot. They're also not future compatible with capabilities such as incremental ingestion and permissions. While they continue to be supported, we highly recommend using Content Gateway when possible. Post in Moveworks Community if you have additional requirements.