The Reference section provides implementation-verified definitions for the core objects, system constants, permission templates, and application error codes used throughout YS Desk.
Use Reference when you need to understand the structure or allowed values of a YS Desk object. Use the other documentation sections for behavior and workflows:
- REST API documents HTTP endpoints, request parameters, response payloads, authentication, pagination, and API operations.
- Real-Time documents Socket.IO connections, events, rooms, and real-time message delivery.
- Webhooks documents payment-provider webhook events, signature verification, and delivery handling.
- Guides documents dashboard workflows and user-facing configuration steps.
Reference focuses on the reusable technical definitions shared across these systems.
Reference Architecture
Objects
- [Workspace & Channel Objects]
- [Identity & User Objects]
- [Conversation & Message Objects]
- [Feedback & Automation Objects]
- [Billing & Notification Objects]
System Constants & States
Centralized enumeration and state definitions used throughout YS Desk.
Permission Templates
Role defaults, reusable permission templates, permission groups, and dependency rules.
Error Codes
Application-level error codes and the standard error response structure.
Need Help?
Email: support@ysdesk.com
Documentation: https://docs.ysplugins.com/ys-desk