Feedback & Automation Objects

Feedback and automation objects represent Conversation feedback, Team Member mentions, Saved Replies, and product-interest information.

CSAT Object

CSATRating represents a Customer Satisfaction rating submitted for a Conversation.

Fields

Field	Type	Description
id	string	CSAT record identifier.
rating	integer	Rating from 1 through 5.
comment	string	Optional written feedback.
conversationId	string	Related Conversation.
guestId	string	Visitor submitting the rating.
workspaceId	string	Owning Workspace.
submittedAt	ISO-8601 timestamp	Submission timestamp.

CSAT behavior is associated with Conversation resolution when CSAT is enabled.

Mentions Object

Mention represents a Team Member mention associated with a Message.

Field	Type	Description
id	string	Mention identifier.
conversationId	string	Conversation containing the mention.
messageId	string	Message containing the mention.
mentionedUserId	string	Team Member who was mentioned.
mentionedBy	string	User who created the mention.
readAt	ISO-8601 timestamp	Time the mention was read, when available.
createdAt	ISO-8601 timestamp	Mention creation timestamp.

Mentions use the @name syntax in the dashboard.

Saved Replies

YS Desk uses the product term Saved Replies. The underlying implementation model is named CannedResponse.

A Saved Reply is a reusable message snippet that Team Members can insert into a Conversation.

Fields

Field	Type	Description
id	string	Saved Reply identifier.
name	string	Slash shortcut identifier.
message	string	Saved Reply content.
category	string	Saved Reply category. Defaults to General.
visibility	Visibility	Availability scope.
userId	string	User associated with the Saved Reply.
workspaceId	string	Owning Workspace.
createdAt	ISO-8601 timestamp	Creation timestamp.

Shortcut Syntax

Saved Replies use slash shortcuts:

/greeting

Do not document #shortcut syntax.

Visibility

Value	Description
PUBLIC	Available according to Workspace Saved Reply access rules.
PRIVATE	Restricted to the creator.

Plan Limits

The currently verified Saved Reply limits are:

Plan	Saved Reply Limit
FREE	10
STARTER	50
GROWTH	Unlimited
ENTERPRISE	Unlimited

Notification Data

NotificationData represents the structured event data passed into the notification system.

The internal NotificationQueue persistence model is not a public Reference object. It is an internal asynchronous processing mechanism.

Batching metadata such as grouping information may be used internally by the notification system but does not represent a public queue implementation contract.

Feature Interest

FeatureInterest represents a product-feature interest submission.

Typical information includes:

• Feature name
• User email
• User name
• Workspace association
• Creation timestamp

Need Help?

Email: support@ysdesk.com

Documentation: https://docs.ysplugins.com/ys-desk