Mentor

Rate one of Heph's messages as helpful or not helpful

Changed on
put/workspaces/{workspaceSlug}/mentor/entries/{entryId}/vote

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces/{workspaceSlug}/mentor/entries/{entryId}/vote
  • Auth: HTTP bearer

Path parameters

workspaceSlugstring required

Workspace slug

entryIdstring uuid required

Request body

vote'HELPFUL' | 'NOT_HELPFUL' required

Response

The message with its vote

conversationIdstring uuid required
createdAtstring date-time required
deletedboolean required

The message was deleted; its text is gone

editedAtstring date-time

Set when the developer edited the message in Slack

idstring uuid required
kind'USER' | 'HEPH' | 'DIGEST' required
parentEntryIdstring uuid

Set when the message is in a thread: the top-level message the thread replies to

requestIdstring

The submission that wrote the message; the app matches its own optimistic message by it

seqinteger required

Order within its conversation

slackDelivery'PENDING' | 'DELIVERED' | 'UNCERTAIN' | 'FAILED'

Only on a question asked in Slack: whether Heph's reply reached Slack. FAILED means Slack does not show the whole reply: it is not there, or a stream showed only part of it before Slack or Silent Mode refused the rest; the full reply is in the app. UNCERTAIN means Slack cannot tell.

surface'APP' | 'SLACK' | 'SYSTEM' required

Where the message was written; SYSTEM for a weekly digest

textstring required

The developer's words or Heph's answer; for a weekly digest, the note that points Heph to it; empty when the message was deleted

turnErrorstring

Why the turn this question asked failed, in words for the developer; only when it FAILED

turnIdstring uuid

The turn the message asked or answered

turnStatus'QUEUED' | 'RUNNING' | 'DONE' | 'FAILED' | 'STOPPED'

The status of the turn this question asked; only on the developer's messages

vote'HELPFUL' | 'NOT_HELPFUL'

The developer's vote; only on Heph's messages

Changes