Create the Conversations API chatbot

Create the chatbot entry that represents your Conversations API integration and produces the Bot Name you send in the Assistant-Name header.

View as Markdown

The Conversations API is in Controlled Availability. Endpoints, behaviors, and configuration surfaces may change during CA. Contact your Moveworks account team to participate.

Every Conversations API request carries an Assistant-Name header naming the chatbot it is addressed to. You create that chatbot once, in Moveworks Setup, before configuring authentication.

Do this first. The Bot Name it produces is an input to whichever authentication guide you follow next.

Prerequisites

  • Your account team has enabled the Conversations API for your org. Until they have, Conversations API requests return 404 regardless of what you configure here.
  • Edit access to Moveworks Setup for your org.

Create the chatbot

In Moveworks Setup, go to Chat Platforms > Manage Chatbots > Chatbots, then create a new entry:

FieldValue
Channelconversationsrestapi
Select Connectorconversations_rest_api
Bot IDAny UUID you generate
Bot NameYour choice. Include -capi so it is recognizable alongside your other chatbots, for example acme-capi. This is the value you send in Assistant-Name.
Bot Friendly NameMatch the Bot Name

Save the entry, then record the Bot Name.

The Assistant-Name header must match the Bot Name exactly. A mismatch is rejected at the API rather than falling back to a default chatbot.

Next steps

Continue with the authentication guide that matches how your integration will identify users: