From fa66a0a23e062925d34bca6f9744f0a4fcd49074 Mon Sep 17 00:00:00 2001 From: preslavmihaylov Date: Fri, 7 Mar 2025 16:42:00 +0200 Subject: [PATCH 1/2] update slack docs --- mint.json | 716 ++++++++++++++++++------------------ slack/how-to-rename-bot.mdx | 10 + 2 files changed, 377 insertions(+), 349 deletions(-) create mode 100644 slack/how-to-rename-bot.mdx diff --git a/mint.json b/mint.json index 5269bb4..7f87c60 100644 --- a/mint.json +++ b/mint.json @@ -1,351 +1,369 @@ { - "name": "Plain Docs", - "logo": { - "light": "public/logo/light.png", - "dark": "public/logo/dark.png", - "url": "https://plain.com" - }, - "feedback": { - "raiseIssue": true, - "suggestEdit": true, - "thumbsRating": true - }, - "favicon": "public/favicon/favicon.png", - "colors": { - "primary": "#1349e8", - "light": "#94a3b8", - "dark": "#3e7cff" - }, - "analytics": { - "plausible": { - "domain": "plain.com" - }, - "gtm": { - "tagId": "GTM-M9JGV3MQ" - } - }, - "metadata": { - "og:image": "https://mintlify.s3-us-west-1.amazonaws.com/plain/public/images/social-image.png", - "twitter:card": "summary_large_image", - "twitter:image": "https://mintlify.s3-us-west-1.amazonaws.com/plain/public/images/social-image.png", - "twitter:site:domain": "plain.com", - "apple-mobile-web-app-title": "Plain Docs" - }, - "topbarCtaButton": { - "name": "Sign in", - "url": "https://app.plain.com/" - }, - "topbarLinks": [ - { - "name": "@plainsupport", - "url": "https://twitter.com/plainsupport" - } - ], - "tabs": [ - { - "name": "Knowledge Base", - "url": "knowledge-base" - }, - { - "name": "API Reference", - "url": "api-reference" - } - ], - "anchors": [ - { - "name": "Knowledge Base", - "icon": "books", - "url": "knowledge-base" - }, - { - "name": "Changelog", - "icon": "code-commit", - "url": "https://plain.com/changelog/?utm_source=docs" - }, - { - "name": "Blog", - "icon": "quote-right", - "url": "https://plain.com/blog/?utm_source=docs" - }, - { - "name": "Book a demo", - "icon": "calendar", - "url": "https://www.plain.com/signup/demo?utm_source=docs" - } - ], - "navigation": [ - { - "group": "Plain 101", - "pages": ["quickstart", "data-model", "security"] - }, - { - "group": "Channels", - "pages": [ - { - "group": "Email", - "pages": [ - "email", - "email/receiving", - "email/sending", - "email/alternate-emails", - "email/email-avatars" - ] - }, - { - "group": "Slack", - "pages": ["slack", "slack/ingestion-modes", "slack/data-retention"] - }, - { - "group": "Discord", - "pages": ["discord/overview"] - }, - { - "group": "Chat", - "pages": ["chat", "chat/customization", "chat/authentication"] - }, - { - "group": "Microsoft Teams", - "pages": ["microsoft-teams", "microsoft-teams/installation"] - }, - "contact-forms", - "headless-support-portal" - ] - }, - { - "group": "Using Plain", - "pages": [ - "statuses", - "notifications", - "assignment", - { - "group": "Plain AI", - "pages": [ - "plain-ai", - "plain-ai/workflow", - "plain-ai/suggested-responses", - "plain-ai/knowledge-sources" - ] - }, - "tiers", - "priorities", - "labels", - "syntax-highlighting", - { - "group": "Reporting", - "pages": [ - "reporting", - "reporting/using-reporting", - "reporting/team-reporting", - "reporting/metrics" - ] - }, - "snippets", - "shortcuts", - "auto-responses", - "workflow-rules", - "digests", - "broadcasts", - "roles-in-plain", - "saved-views", - "favorite-pages" - ] - }, - { - "group": "Integrations", - "pages": [ - "integrations/linear", - "integrations/jira", - "integrations/shortcut", - "integrations/salesforce", - "integrations/zendesk", - "integrations/discourse", - "integrations/helpscout", - "integrations/hubspot", - "integrations/inkeep" - ] - }, - { - "group": "Adding context", - "pages": [ - "company-support", - "tenant-support", - "thread-fields", - "thread-discussions", - "customer-cards", - "customer-groups", - "events" - ] - }, - { - "group": "GraphQL", - "pages": [ - "api-reference/graphql/introduction", - "api-reference/graphql/authentication", - "api-reference/graphql/schema", - { - "group": "Customers", - "pages": [ - "api-reference/graphql/customers", - "api-reference/graphql/customers/get", - "api-reference/graphql/customers/upsert", - "api-reference/graphql/customers/delete", - "api-reference/graphql/customers/customer-groups" - ] - }, - { - "group": "Companies", - "pages": [ - "api-reference/graphql/companies", - "api-reference/graphql/companies/get-companies", - "api-reference/graphql/companies/update-customer-company" - ] - }, - { - "group": "Tenants", - "pages": [ - "api-reference/graphql/tenants", - "api-reference/graphql/tenants/upsert", - "api-reference/graphql/tenants/get", - "api-reference/graphql/tenants/add-customers", - "api-reference/graphql/tenants/remove-customers", - "api-reference/graphql/tenants/set-customer-tenants" - ] - }, - { - "group": "Threads", - "pages": [ - "api-reference/graphql/threads", - "api-reference/graphql/threads/create", - "api-reference/graphql/threads/assignment", - "api-reference/graphql/threads/thread-fields", - "api-reference/graphql/threads/status-changes", - "api-reference/graphql/threads/autoresponders" - ] - }, - { - "group": "Tiers", - "pages": [ - "api-reference/graphql/tiers", - "api-reference/graphql/tiers/get", - "api-reference/graphql/tiers/update-company-tier", - "api-reference/graphql/tiers/update-tenant-tier", - "api-reference/graphql/tiers/add-members", - "api-reference/graphql/tiers/remove-members" - ] - }, - { - "group": "Events", - "pages": [ - "api-reference/graphql/events", - "api-reference/graphql/events/create-customer-event", - "api-reference/graphql/events/create-thread-event" - ] - }, - { - "group": "Labels", - "pages": [ - "api-reference/graphql/labels", - "api-reference/graphql/labels/add", - "api-reference/graphql/labels/remove" - ] - }, - { - "group": "Messaging", - "pages": [ - "api-reference/graphql/messaging", - "api-reference/graphql/messaging/reply-to-thread", - "api-reference/graphql/messaging/send-email", - "api-reference/graphql/messaging/reply-email" - ] - }, - "api-reference/graphql/pagination", - "api-reference/graphql/error-handling", - "api-reference/graphql/error-codes", - "api-reference/graphql/api-explorer", - "api-reference/graphql/typescript-sdk" - ] - }, - { - "group": "Reference", - "pages": [ - { - "group": "Customer cards", - "pages": [ - "api-reference/customer-cards", - "api-reference/customer-cards/create-a-customer-card", - "api-reference/customer-cards/protocol", - "api-reference/customer-cards/playground", - "api-reference/customer-cards/examples" - ] - }, - { - "group": "Webhooks", - "pages": [ - "api-reference/webhooks", - "api-reference/webhooks/versions", - "api-reference/webhooks/typescript", - "api-reference/webhooks/thread-created", - "api-reference/webhooks/thread-status-transitioned", - "api-reference/webhooks/thread-assignment-transitioned", - "api-reference/webhooks/thread-labels-changed", - "api-reference/webhooks/thread-priority-changed", - "api-reference/webhooks/thread-note-created", - "api-reference/webhooks/thread-email-received", - "api-reference/webhooks/thread-email-sent", - "api-reference/webhooks/thread-slack-message-received", - "api-reference/webhooks/thread-slack-message-sent", - "api-reference/webhooks/thread-chat-sent", - "api-reference/webhooks/thread-chat-received", - "api-reference/webhooks/thread-field-created", - "api-reference/webhooks/thread-field-updated", - "api-reference/webhooks/thread-field-deleted", - "api-reference/webhooks/thread-service-level-agreement-status-transitioned", - "api-reference/webhooks/customer-created", - "api-reference/webhooks/customer-updated", - "api-reference/webhooks/customer-deleted", - "api-reference/webhooks/customer-group-membership-changed" - ] - }, - "api-reference/request-signing", - "api-reference/mtls", - { - "group": "UI Components", - "pages": [ - "api-reference/ui-components", - "api-reference/ui-components/badge", - "api-reference/ui-components/container", - "api-reference/ui-components/copy-button", - "api-reference/ui-components/divider", - "api-reference/ui-components/link-button", - "api-reference/ui-components/plain-text", - "api-reference/ui-components/row", - "api-reference/ui-components/spacer", - "api-reference/ui-components/text" - ] - }, - "api-reference/attachments" - ] - }, - { - "group": "Knowledge Base", - "pages": [ - "knowledge-base/overview", - "knowledge-base/kb-personal-email", - "knowledge-base/kb-setup-time", - "knowledge-base/kb-soc2", - "knowledge-base/kb-forwarding-emails" - ] - } - ], - "footerSocials": { - "twitter": "https://twitter.com/plainsupport", - "linkedin": "https://www.linkedin.com/company/plainsupport", - "github": "https://github.com/team-plain/docs" - }, - "redirects": [ - { - "source": "/api-reference/headless-portal", - "destination": "/headless-support-portal" - } - ] + "name": "Plain Docs", + "logo": { + "light": "public/logo/light.png", + "dark": "public/logo/dark.png", + "url": "https://plain.com" + }, + "feedback": { + "raiseIssue": true, + "suggestEdit": true, + "thumbsRating": true + }, + "favicon": "public/favicon/favicon.png", + "colors": { + "primary": "#1349e8", + "light": "#94a3b8", + "dark": "#3e7cff" + }, + "analytics": { + "plausible": { + "domain": "plain.com" + }, + "gtm": { + "tagId": "GTM-M9JGV3MQ" + } + }, + "metadata": { + "og:image": "https://mintlify.s3-us-west-1.amazonaws.com/plain/public/images/social-image.png", + "twitter:card": "summary_large_image", + "twitter:image": "https://mintlify.s3-us-west-1.amazonaws.com/plain/public/images/social-image.png", + "twitter:site:domain": "plain.com", + "apple-mobile-web-app-title": "Plain Docs" + }, + "topbarCtaButton": { + "name": "Sign in", + "url": "https://app.plain.com/" + }, + "topbarLinks": [ + { + "name": "@plainsupport", + "url": "https://twitter.com/plainsupport" + } + ], + "tabs": [ + { + "name": "Knowledge Base", + "url": "knowledge-base" + }, + { + "name": "API Reference", + "url": "api-reference" + } + ], + "anchors": [ + { + "name": "Knowledge Base", + "icon": "books", + "url": "knowledge-base" + }, + { + "name": "Changelog", + "icon": "code-commit", + "url": "https://plain.com/changelog/?utm_source=docs" + }, + { + "name": "Blog", + "icon": "quote-right", + "url": "https://plain.com/blog/?utm_source=docs" + }, + { + "name": "Book a demo", + "icon": "calendar", + "url": "https://www.plain.com/signup/demo?utm_source=docs" + } + ], + "navigation": [ + { + "group": "Plain 101", + "pages": [ + "quickstart", + "data-model", + "security" + ] + }, + { + "group": "Channels", + "pages": [ + { + "group": "Email", + "pages": [ + "email", + "email/receiving", + "email/sending", + "email/alternate-emails", + "email/email-avatars" + ] + }, + { + "group": "Slack", + "pages": [ + "slack", + "slack/ingestion-modes", + "slack/data-retention", + "slack/how-to-rename-bot" + ] + }, + { + "group": "Discord", + "pages": [ + "discord/overview" + ] + }, + { + "group": "Chat", + "pages": [ + "chat", + "chat/customization", + "chat/authentication" + ] + }, + { + "group": "Microsoft Teams", + "pages": [ + "microsoft-teams", + "microsoft-teams/installation" + ] + }, + "contact-forms", + "headless-support-portal" + ] + }, + { + "group": "Using Plain", + "pages": [ + "statuses", + "notifications", + "assignment", + { + "group": "Plain AI", + "pages": [ + "plain-ai", + "plain-ai/workflow", + "plain-ai/suggested-responses", + "plain-ai/knowledge-sources" + ] + }, + "tiers", + "priorities", + "labels", + "syntax-highlighting", + { + "group": "Reporting", + "pages": [ + "reporting", + "reporting/using-reporting", + "reporting/team-reporting", + "reporting/metrics" + ] + }, + "snippets", + "shortcuts", + "auto-responses", + "workflow-rules", + "digests", + "broadcasts", + "roles-in-plain", + "saved-views", + "favorite-pages" + ] + }, + { + "group": "Integrations", + "pages": [ + "integrations/linear", + "integrations/jira", + "integrations/shortcut", + "integrations/salesforce", + "integrations/zendesk", + "integrations/discourse", + "integrations/helpscout", + "integrations/hubspot", + "integrations/inkeep" + ] + }, + { + "group": "Adding context", + "pages": [ + "company-support", + "tenant-support", + "thread-fields", + "thread-discussions", + "customer-cards", + "customer-groups", + "events" + ] + }, + { + "group": "GraphQL", + "pages": [ + "api-reference/graphql/introduction", + "api-reference/graphql/authentication", + "api-reference/graphql/schema", + { + "group": "Customers", + "pages": [ + "api-reference/graphql/customers", + "api-reference/graphql/customers/get", + "api-reference/graphql/customers/upsert", + "api-reference/graphql/customers/delete", + "api-reference/graphql/customers/customer-groups" + ] + }, + { + "group": "Companies", + "pages": [ + "api-reference/graphql/companies", + "api-reference/graphql/companies/get-companies", + "api-reference/graphql/companies/update-customer-company" + ] + }, + { + "group": "Tenants", + "pages": [ + "api-reference/graphql/tenants", + "api-reference/graphql/tenants/upsert", + "api-reference/graphql/tenants/get", + "api-reference/graphql/tenants/add-customers", + "api-reference/graphql/tenants/remove-customers", + "api-reference/graphql/tenants/set-customer-tenants" + ] + }, + { + "group": "Threads", + "pages": [ + "api-reference/graphql/threads", + "api-reference/graphql/threads/create", + "api-reference/graphql/threads/assignment", + "api-reference/graphql/threads/thread-fields", + "api-reference/graphql/threads/status-changes", + "api-reference/graphql/threads/autoresponders" + ] + }, + { + "group": "Tiers", + "pages": [ + "api-reference/graphql/tiers", + "api-reference/graphql/tiers/get", + "api-reference/graphql/tiers/update-company-tier", + "api-reference/graphql/tiers/update-tenant-tier", + "api-reference/graphql/tiers/add-members", + "api-reference/graphql/tiers/remove-members" + ] + }, + { + "group": "Events", + "pages": [ + "api-reference/graphql/events", + "api-reference/graphql/events/create-customer-event", + "api-reference/graphql/events/create-thread-event" + ] + }, + { + "group": "Labels", + "pages": [ + "api-reference/graphql/labels", + "api-reference/graphql/labels/add", + "api-reference/graphql/labels/remove" + ] + }, + { + "group": "Messaging", + "pages": [ + "api-reference/graphql/messaging", + "api-reference/graphql/messaging/reply-to-thread", + "api-reference/graphql/messaging/send-email", + "api-reference/graphql/messaging/reply-email" + ] + }, + "api-reference/graphql/pagination", + "api-reference/graphql/error-handling", + "api-reference/graphql/error-codes", + "api-reference/graphql/api-explorer", + "api-reference/graphql/typescript-sdk" + ] + }, + { + "group": "Reference", + "pages": [ + { + "group": "Customer cards", + "pages": [ + "api-reference/customer-cards", + "api-reference/customer-cards/create-a-customer-card", + "api-reference/customer-cards/protocol", + "api-reference/customer-cards/playground", + "api-reference/customer-cards/examples" + ] + }, + { + "group": "Webhooks", + "pages": [ + "api-reference/webhooks", + "api-reference/webhooks/versions", + "api-reference/webhooks/typescript", + "api-reference/webhooks/thread-created", + "api-reference/webhooks/thread-status-transitioned", + "api-reference/webhooks/thread-assignment-transitioned", + "api-reference/webhooks/thread-labels-changed", + "api-reference/webhooks/thread-priority-changed", + "api-reference/webhooks/thread-note-created", + "api-reference/webhooks/thread-email-received", + "api-reference/webhooks/thread-email-sent", + "api-reference/webhooks/thread-slack-message-received", + "api-reference/webhooks/thread-slack-message-sent", + "api-reference/webhooks/thread-chat-sent", + "api-reference/webhooks/thread-chat-received", + "api-reference/webhooks/thread-field-created", + "api-reference/webhooks/thread-field-updated", + "api-reference/webhooks/thread-field-deleted", + "api-reference/webhooks/thread-service-level-agreement-status-transitioned", + "api-reference/webhooks/customer-created", + "api-reference/webhooks/customer-updated", + "api-reference/webhooks/customer-deleted", + "api-reference/webhooks/customer-group-membership-changed" + ] + }, + "api-reference/request-signing", + "api-reference/mtls", + { + "group": "UI Components", + "pages": [ + "api-reference/ui-components", + "api-reference/ui-components/badge", + "api-reference/ui-components/container", + "api-reference/ui-components/copy-button", + "api-reference/ui-components/divider", + "api-reference/ui-components/link-button", + "api-reference/ui-components/plain-text", + "api-reference/ui-components/row", + "api-reference/ui-components/spacer", + "api-reference/ui-components/text" + ] + }, + "api-reference/attachments" + ] + }, + { + "group": "Knowledge Base", + "pages": [ + "knowledge-base/overview", + "knowledge-base/kb-personal-email", + "knowledge-base/kb-setup-time", + "knowledge-base/kb-soc2", + "knowledge-base/kb-forwarding-emails" + ] + } + ], + "footerSocials": { + "twitter": "https://twitter.com/plainsupport", + "linkedin": "https://www.linkedin.com/company/plainsupport", + "github": "https://github.com/team-plain/docs" + }, + "redirects": [ + { + "source": "/api-reference/headless-portal", + "destination": "/headless-support-portal" + } + ] } diff --git a/slack/how-to-rename-bot.mdx b/slack/how-to-rename-bot.mdx new file mode 100644 index 0000000..7a626d6 --- /dev/null +++ b/slack/how-to-rename-bot.mdx @@ -0,0 +1,10 @@ +--- +title: 'How to rename your Slack bot' +--- + +By default, when the Plain bot is added to a channel, it will have the name `Plain`, but you can adjust this via your slack workspace settings. + +To do that, open [The slack bot page](https://plaintestworkspace.slack.com/marketplace/A03RQJJFZUP-plain) and then: + * Choose your slack workspace at the top-right + * Go to Configuration > Bot User and click "Edit" + From ffe04ab7087d112c9fb7f0c240c934aaafc05b98 Mon Sep 17 00:00:00 2001 From: preslavmihaylov Date: Fri, 7 Mar 2025 19:01:49 +0200 Subject: [PATCH 2/2] lint --- mint.json | 721 +++++++++++++++++++++++++++--------------------------- 1 file changed, 354 insertions(+), 367 deletions(-) diff --git a/mint.json b/mint.json index 7f87c60..7fc0975 100644 --- a/mint.json +++ b/mint.json @@ -1,369 +1,356 @@ { - "name": "Plain Docs", - "logo": { - "light": "public/logo/light.png", - "dark": "public/logo/dark.png", - "url": "https://plain.com" - }, - "feedback": { - "raiseIssue": true, - "suggestEdit": true, - "thumbsRating": true - }, - "favicon": "public/favicon/favicon.png", - "colors": { - "primary": "#1349e8", - "light": "#94a3b8", - "dark": "#3e7cff" - }, - "analytics": { - "plausible": { - "domain": "plain.com" - }, - "gtm": { - "tagId": "GTM-M9JGV3MQ" - } - }, - "metadata": { - "og:image": "https://mintlify.s3-us-west-1.amazonaws.com/plain/public/images/social-image.png", - "twitter:card": "summary_large_image", - "twitter:image": "https://mintlify.s3-us-west-1.amazonaws.com/plain/public/images/social-image.png", - "twitter:site:domain": "plain.com", - "apple-mobile-web-app-title": "Plain Docs" - }, - "topbarCtaButton": { - "name": "Sign in", - "url": "https://app.plain.com/" - }, - "topbarLinks": [ - { - "name": "@plainsupport", - "url": "https://twitter.com/plainsupport" - } - ], - "tabs": [ - { - "name": "Knowledge Base", - "url": "knowledge-base" - }, - { - "name": "API Reference", - "url": "api-reference" - } - ], - "anchors": [ - { - "name": "Knowledge Base", - "icon": "books", - "url": "knowledge-base" - }, - { - "name": "Changelog", - "icon": "code-commit", - "url": "https://plain.com/changelog/?utm_source=docs" - }, - { - "name": "Blog", - "icon": "quote-right", - "url": "https://plain.com/blog/?utm_source=docs" - }, - { - "name": "Book a demo", - "icon": "calendar", - "url": "https://www.plain.com/signup/demo?utm_source=docs" - } - ], - "navigation": [ - { - "group": "Plain 101", - "pages": [ - "quickstart", - "data-model", - "security" - ] - }, - { - "group": "Channels", - "pages": [ - { - "group": "Email", - "pages": [ - "email", - "email/receiving", - "email/sending", - "email/alternate-emails", - "email/email-avatars" - ] - }, - { - "group": "Slack", - "pages": [ - "slack", - "slack/ingestion-modes", - "slack/data-retention", - "slack/how-to-rename-bot" - ] - }, - { - "group": "Discord", - "pages": [ - "discord/overview" - ] - }, - { - "group": "Chat", - "pages": [ - "chat", - "chat/customization", - "chat/authentication" - ] - }, - { - "group": "Microsoft Teams", - "pages": [ - "microsoft-teams", - "microsoft-teams/installation" - ] - }, - "contact-forms", - "headless-support-portal" - ] - }, - { - "group": "Using Plain", - "pages": [ - "statuses", - "notifications", - "assignment", - { - "group": "Plain AI", - "pages": [ - "plain-ai", - "plain-ai/workflow", - "plain-ai/suggested-responses", - "plain-ai/knowledge-sources" - ] - }, - "tiers", - "priorities", - "labels", - "syntax-highlighting", - { - "group": "Reporting", - "pages": [ - "reporting", - "reporting/using-reporting", - "reporting/team-reporting", - "reporting/metrics" - ] - }, - "snippets", - "shortcuts", - "auto-responses", - "workflow-rules", - "digests", - "broadcasts", - "roles-in-plain", - "saved-views", - "favorite-pages" - ] - }, - { - "group": "Integrations", - "pages": [ - "integrations/linear", - "integrations/jira", - "integrations/shortcut", - "integrations/salesforce", - "integrations/zendesk", - "integrations/discourse", - "integrations/helpscout", - "integrations/hubspot", - "integrations/inkeep" - ] - }, - { - "group": "Adding context", - "pages": [ - "company-support", - "tenant-support", - "thread-fields", - "thread-discussions", - "customer-cards", - "customer-groups", - "events" - ] - }, - { - "group": "GraphQL", - "pages": [ - "api-reference/graphql/introduction", - "api-reference/graphql/authentication", - "api-reference/graphql/schema", - { - "group": "Customers", - "pages": [ - "api-reference/graphql/customers", - "api-reference/graphql/customers/get", - "api-reference/graphql/customers/upsert", - "api-reference/graphql/customers/delete", - "api-reference/graphql/customers/customer-groups" - ] - }, - { - "group": "Companies", - "pages": [ - "api-reference/graphql/companies", - "api-reference/graphql/companies/get-companies", - "api-reference/graphql/companies/update-customer-company" - ] - }, - { - "group": "Tenants", - "pages": [ - "api-reference/graphql/tenants", - "api-reference/graphql/tenants/upsert", - "api-reference/graphql/tenants/get", - "api-reference/graphql/tenants/add-customers", - "api-reference/graphql/tenants/remove-customers", - "api-reference/graphql/tenants/set-customer-tenants" - ] - }, - { - "group": "Threads", - "pages": [ - "api-reference/graphql/threads", - "api-reference/graphql/threads/create", - "api-reference/graphql/threads/assignment", - "api-reference/graphql/threads/thread-fields", - "api-reference/graphql/threads/status-changes", - "api-reference/graphql/threads/autoresponders" - ] - }, - { - "group": "Tiers", - "pages": [ - "api-reference/graphql/tiers", - "api-reference/graphql/tiers/get", - "api-reference/graphql/tiers/update-company-tier", - "api-reference/graphql/tiers/update-tenant-tier", - "api-reference/graphql/tiers/add-members", - "api-reference/graphql/tiers/remove-members" - ] - }, - { - "group": "Events", - "pages": [ - "api-reference/graphql/events", - "api-reference/graphql/events/create-customer-event", - "api-reference/graphql/events/create-thread-event" - ] - }, - { - "group": "Labels", - "pages": [ - "api-reference/graphql/labels", - "api-reference/graphql/labels/add", - "api-reference/graphql/labels/remove" - ] - }, - { - "group": "Messaging", - "pages": [ - "api-reference/graphql/messaging", - "api-reference/graphql/messaging/reply-to-thread", - "api-reference/graphql/messaging/send-email", - "api-reference/graphql/messaging/reply-email" - ] - }, - "api-reference/graphql/pagination", - "api-reference/graphql/error-handling", - "api-reference/graphql/error-codes", - "api-reference/graphql/api-explorer", - "api-reference/graphql/typescript-sdk" - ] - }, - { - "group": "Reference", - "pages": [ - { - "group": "Customer cards", - "pages": [ - "api-reference/customer-cards", - "api-reference/customer-cards/create-a-customer-card", - "api-reference/customer-cards/protocol", - "api-reference/customer-cards/playground", - "api-reference/customer-cards/examples" - ] - }, - { - "group": "Webhooks", - "pages": [ - "api-reference/webhooks", - "api-reference/webhooks/versions", - "api-reference/webhooks/typescript", - "api-reference/webhooks/thread-created", - "api-reference/webhooks/thread-status-transitioned", - "api-reference/webhooks/thread-assignment-transitioned", - "api-reference/webhooks/thread-labels-changed", - "api-reference/webhooks/thread-priority-changed", - "api-reference/webhooks/thread-note-created", - "api-reference/webhooks/thread-email-received", - "api-reference/webhooks/thread-email-sent", - "api-reference/webhooks/thread-slack-message-received", - "api-reference/webhooks/thread-slack-message-sent", - "api-reference/webhooks/thread-chat-sent", - "api-reference/webhooks/thread-chat-received", - "api-reference/webhooks/thread-field-created", - "api-reference/webhooks/thread-field-updated", - "api-reference/webhooks/thread-field-deleted", - "api-reference/webhooks/thread-service-level-agreement-status-transitioned", - "api-reference/webhooks/customer-created", - "api-reference/webhooks/customer-updated", - "api-reference/webhooks/customer-deleted", - "api-reference/webhooks/customer-group-membership-changed" - ] - }, - "api-reference/request-signing", - "api-reference/mtls", - { - "group": "UI Components", - "pages": [ - "api-reference/ui-components", - "api-reference/ui-components/badge", - "api-reference/ui-components/container", - "api-reference/ui-components/copy-button", - "api-reference/ui-components/divider", - "api-reference/ui-components/link-button", - "api-reference/ui-components/plain-text", - "api-reference/ui-components/row", - "api-reference/ui-components/spacer", - "api-reference/ui-components/text" - ] - }, - "api-reference/attachments" - ] - }, - { - "group": "Knowledge Base", - "pages": [ - "knowledge-base/overview", - "knowledge-base/kb-personal-email", - "knowledge-base/kb-setup-time", - "knowledge-base/kb-soc2", - "knowledge-base/kb-forwarding-emails" - ] - } - ], - "footerSocials": { - "twitter": "https://twitter.com/plainsupport", - "linkedin": "https://www.linkedin.com/company/plainsupport", - "github": "https://github.com/team-plain/docs" - }, - "redirects": [ - { - "source": "/api-reference/headless-portal", - "destination": "/headless-support-portal" - } - ] + "name": "Plain Docs", + "logo": { + "light": "public/logo/light.png", + "dark": "public/logo/dark.png", + "url": "https://plain.com" + }, + "feedback": { + "raiseIssue": true, + "suggestEdit": true, + "thumbsRating": true + }, + "favicon": "public/favicon/favicon.png", + "colors": { + "primary": "#1349e8", + "light": "#94a3b8", + "dark": "#3e7cff" + }, + "analytics": { + "plausible": { + "domain": "plain.com" + }, + "gtm": { + "tagId": "GTM-M9JGV3MQ" + } + }, + "metadata": { + "og:image": "https://mintlify.s3-us-west-1.amazonaws.com/plain/public/images/social-image.png", + "twitter:card": "summary_large_image", + "twitter:image": "https://mintlify.s3-us-west-1.amazonaws.com/plain/public/images/social-image.png", + "twitter:site:domain": "plain.com", + "apple-mobile-web-app-title": "Plain Docs" + }, + "topbarCtaButton": { + "name": "Sign in", + "url": "https://app.plain.com/" + }, + "topbarLinks": [ + { + "name": "@plainsupport", + "url": "https://twitter.com/plainsupport" + } + ], + "tabs": [ + { + "name": "Knowledge Base", + "url": "knowledge-base" + }, + { + "name": "API Reference", + "url": "api-reference" + } + ], + "anchors": [ + { + "name": "Knowledge Base", + "icon": "books", + "url": "knowledge-base" + }, + { + "name": "Changelog", + "icon": "code-commit", + "url": "https://plain.com/changelog/?utm_source=docs" + }, + { + "name": "Blog", + "icon": "quote-right", + "url": "https://plain.com/blog/?utm_source=docs" + }, + { + "name": "Book a demo", + "icon": "calendar", + "url": "https://www.plain.com/signup/demo?utm_source=docs" + } + ], + "navigation": [ + { + "group": "Plain 101", + "pages": ["quickstart", "data-model", "security"] + }, + { + "group": "Channels", + "pages": [ + { + "group": "Email", + "pages": [ + "email", + "email/receiving", + "email/sending", + "email/alternate-emails", + "email/email-avatars" + ] + }, + { + "group": "Slack", + "pages": [ + "slack", + "slack/ingestion-modes", + "slack/data-retention", + "slack/how-to-rename-bot" + ] + }, + { + "group": "Discord", + "pages": ["discord/overview"] + }, + { + "group": "Chat", + "pages": ["chat", "chat/customization", "chat/authentication"] + }, + { + "group": "Microsoft Teams", + "pages": ["microsoft-teams", "microsoft-teams/installation"] + }, + "contact-forms", + "headless-support-portal" + ] + }, + { + "group": "Using Plain", + "pages": [ + "statuses", + "notifications", + "assignment", + { + "group": "Plain AI", + "pages": [ + "plain-ai", + "plain-ai/workflow", + "plain-ai/suggested-responses", + "plain-ai/knowledge-sources" + ] + }, + "tiers", + "priorities", + "labels", + "syntax-highlighting", + { + "group": "Reporting", + "pages": [ + "reporting", + "reporting/using-reporting", + "reporting/team-reporting", + "reporting/metrics" + ] + }, + "snippets", + "shortcuts", + "auto-responses", + "workflow-rules", + "digests", + "broadcasts", + "roles-in-plain", + "saved-views", + "favorite-pages" + ] + }, + { + "group": "Integrations", + "pages": [ + "integrations/linear", + "integrations/jira", + "integrations/shortcut", + "integrations/salesforce", + "integrations/zendesk", + "integrations/discourse", + "integrations/helpscout", + "integrations/hubspot", + "integrations/inkeep" + ] + }, + { + "group": "Adding context", + "pages": [ + "company-support", + "tenant-support", + "thread-fields", + "thread-discussions", + "customer-cards", + "customer-groups", + "events" + ] + }, + { + "group": "GraphQL", + "pages": [ + "api-reference/graphql/introduction", + "api-reference/graphql/authentication", + "api-reference/graphql/schema", + { + "group": "Customers", + "pages": [ + "api-reference/graphql/customers", + "api-reference/graphql/customers/get", + "api-reference/graphql/customers/upsert", + "api-reference/graphql/customers/delete", + "api-reference/graphql/customers/customer-groups" + ] + }, + { + "group": "Companies", + "pages": [ + "api-reference/graphql/companies", + "api-reference/graphql/companies/get-companies", + "api-reference/graphql/companies/update-customer-company" + ] + }, + { + "group": "Tenants", + "pages": [ + "api-reference/graphql/tenants", + "api-reference/graphql/tenants/upsert", + "api-reference/graphql/tenants/get", + "api-reference/graphql/tenants/add-customers", + "api-reference/graphql/tenants/remove-customers", + "api-reference/graphql/tenants/set-customer-tenants" + ] + }, + { + "group": "Threads", + "pages": [ + "api-reference/graphql/threads", + "api-reference/graphql/threads/create", + "api-reference/graphql/threads/assignment", + "api-reference/graphql/threads/thread-fields", + "api-reference/graphql/threads/status-changes", + "api-reference/graphql/threads/autoresponders" + ] + }, + { + "group": "Tiers", + "pages": [ + "api-reference/graphql/tiers", + "api-reference/graphql/tiers/get", + "api-reference/graphql/tiers/update-company-tier", + "api-reference/graphql/tiers/update-tenant-tier", + "api-reference/graphql/tiers/add-members", + "api-reference/graphql/tiers/remove-members" + ] + }, + { + "group": "Events", + "pages": [ + "api-reference/graphql/events", + "api-reference/graphql/events/create-customer-event", + "api-reference/graphql/events/create-thread-event" + ] + }, + { + "group": "Labels", + "pages": [ + "api-reference/graphql/labels", + "api-reference/graphql/labels/add", + "api-reference/graphql/labels/remove" + ] + }, + { + "group": "Messaging", + "pages": [ + "api-reference/graphql/messaging", + "api-reference/graphql/messaging/reply-to-thread", + "api-reference/graphql/messaging/send-email", + "api-reference/graphql/messaging/reply-email" + ] + }, + "api-reference/graphql/pagination", + "api-reference/graphql/error-handling", + "api-reference/graphql/error-codes", + "api-reference/graphql/api-explorer", + "api-reference/graphql/typescript-sdk" + ] + }, + { + "group": "Reference", + "pages": [ + { + "group": "Customer cards", + "pages": [ + "api-reference/customer-cards", + "api-reference/customer-cards/create-a-customer-card", + "api-reference/customer-cards/protocol", + "api-reference/customer-cards/playground", + "api-reference/customer-cards/examples" + ] + }, + { + "group": "Webhooks", + "pages": [ + "api-reference/webhooks", + "api-reference/webhooks/versions", + "api-reference/webhooks/typescript", + "api-reference/webhooks/thread-created", + "api-reference/webhooks/thread-status-transitioned", + "api-reference/webhooks/thread-assignment-transitioned", + "api-reference/webhooks/thread-labels-changed", + "api-reference/webhooks/thread-priority-changed", + "api-reference/webhooks/thread-note-created", + "api-reference/webhooks/thread-email-received", + "api-reference/webhooks/thread-email-sent", + "api-reference/webhooks/thread-slack-message-received", + "api-reference/webhooks/thread-slack-message-sent", + "api-reference/webhooks/thread-chat-sent", + "api-reference/webhooks/thread-chat-received", + "api-reference/webhooks/thread-field-created", + "api-reference/webhooks/thread-field-updated", + "api-reference/webhooks/thread-field-deleted", + "api-reference/webhooks/thread-service-level-agreement-status-transitioned", + "api-reference/webhooks/customer-created", + "api-reference/webhooks/customer-updated", + "api-reference/webhooks/customer-deleted", + "api-reference/webhooks/customer-group-membership-changed" + ] + }, + "api-reference/request-signing", + "api-reference/mtls", + { + "group": "UI Components", + "pages": [ + "api-reference/ui-components", + "api-reference/ui-components/badge", + "api-reference/ui-components/container", + "api-reference/ui-components/copy-button", + "api-reference/ui-components/divider", + "api-reference/ui-components/link-button", + "api-reference/ui-components/plain-text", + "api-reference/ui-components/row", + "api-reference/ui-components/spacer", + "api-reference/ui-components/text" + ] + }, + "api-reference/attachments" + ] + }, + { + "group": "Knowledge Base", + "pages": [ + "knowledge-base/overview", + "knowledge-base/kb-personal-email", + "knowledge-base/kb-setup-time", + "knowledge-base/kb-soc2", + "knowledge-base/kb-forwarding-emails" + ] + } + ], + "footerSocials": { + "twitter": "https://twitter.com/plainsupport", + "linkedin": "https://www.linkedin.com/company/plainsupport", + "github": "https://github.com/team-plain/docs" + }, + "redirects": [ + { + "source": "/api-reference/headless-portal", + "destination": "/headless-support-portal" + } + ] }