A YS Desk Workspace is the primary container for channels, team members, visitors, conversations, and billing configuration.
A Channel represents a communication entry point belonging to a Workspace. A Web Chat Channel provides the configuration and token required to initialize the Web Chat widget.
Team Members and Visitors are represented through the user model with different roles and workspace relationships. Team Members authenticate through the dashboard authentication system, while Web Chat Visitors use a workspace- and channel-bound visitor session.
Conversations belong to a Workspace and Channel and connect Visitors with Team Members. Messages belong to Conversations and carry content, delivery state, optional media, threading information, and structured metadata.
Billing objects describe the Workspace subscription, usage, payment transactions, and billing details. Feedback and notification objects provide CSAT, mentions, Saved Replies, and notification configuration.
Safe Credential Conventions
Never place production credentials, database URLs, payment information, or real visitor data in examples.
| Credential | Example Placeholder | Usage |
| Channel Token | <CHANNEL_TOKEN> | Web Chat SDK initialization |
| Auth0 Access Token | <AUTH0_ACCESS_TOKEN> | Authenticated API requests |
| Visitor Session Token | <VISITOR_SESSION_TOKEN> | Visitor session authentication |
| Webhook Secret | <WEBHOOK_SECRET> | Payment webhook verification |
| Provider Event ID | <PROVIDER_EVENT_ID> | Payment-provider event identification |
Payment credentials and database connection strings must never appear in documentation examples.
Need Help?
Email: support@ysdesk.com
Documentation: https://docs.ysplugins.com/ys-desk