Skip to navigation

Employee Slate

View as Markdown

assistant.employee-slate

  • Endpoint: /assistant/employee-slate | 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/assistant/employee-slateGet employee slate
PATCH/assistant/employee-slateUpdate employee slate

Fields

FieldTypeRequiredNotes
connector_trusted_issuer_groupsarray<ConnectorTrustedIssuerGroup>Maps connectors to the ServiceNow instances they authenticate against, supporting multiple instances. Each trusted issuer must be unique.
suggested_promptsarray<SuggestedPrompt>Suggested prompts shown on the Employee Slate home page. Up to 4.
universal_assistant_placeholder_textstringPlaceholder text shown in the assistant input box on the home page before the user types. Up to 130 characters.
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.

{
"connector_trusted_issuer_groups": [
{
"connector_id": "<connector-uuid>",
"trusted_issuer": "<string>",
"item_ref": "<string>"
}
],
"suggested_prompts": [
{
"title": "Example title",
"utterance": "<string>",
"item_ref": "<string>"
}
],
"universal_assistant_placeholder_text": "<string>"
}