Submit feedback

View as Markdown

Submits a feedback rating (helpful or unhelpful) for a specific assistant message.

Use the callback_id from the message’s feedback field to indicate which rating is being submitted. The callback_id is an opaque token. Pass it back exactly as received.

Optionally include additional_feedback for free-text comments.

Authentication

AuthorizationBearer

JWT bearer token authentication. Obtain an access token from the Moveworks auth endpoint and include it in the Authorization header as ‘Bearer <token>’.

Path parameters

conversation_idstringRequired

A base-62 identifier prefixed by a short resource type

response_idstringRequired

A base-62 identifier prefixed by a short resource type

message_idstringRequired

A base-62 identifier prefixed by a short resource type

Headers

Assistant-NamestringRequired
The Moveworks assistant identifier that was configured for your organization.

Request

This endpoint expects an object.
callback_idstringRequired

The callback_id from either feedback.helpful or feedback.unhelpful on the message object. Determines which rating (helpful or unhelpful) is being submitted.

additional_feedbackstringOptional<=1000 characters

Optional free-text feedback from the user. Use this to capture additional context about why the user rated the response this way.

Response headers

x-moveworks-root-uuidstring
A unique identifier used to trace your request within the Moveworks system

Response

Feedback submitted successfully
statusenum
Feedback submission status

Errors

400
Bad Request Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error