-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
24 changed files
with
166 additions
and
49 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: 'Assignment' | ||
--- | ||
|
||
TODO |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
title: 'Customer groups' | ||
description: 'Organise and segment your customers' | ||
--- | ||
|
||
Customer groups can be used to organize and segment your customers. For example you could organise your customers by their tier "Free", "Growth, "Enterprise" or use temporary groups to keep track of customers trialing beta features. | ||
|
||
You can configure the groups in your workspace by going to **Settings** → **Customer Groups** where you can set a name and color per group. | ||
|
||
You can then either manually add a customer to a group from any thread or you can programatically [via the API](/docs/api-reference/graphql/customers/customer-groups). | ||
|
||
You can also filter threads by customer groups so you can for example prioritise threads belonging to Enterprise customers. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
--- | ||
title: 'Data model' | ||
description: 'A quick run-through of how things are structured within Plain.' | ||
--- | ||
|
||
This page will give you a birds eye view of how Plain is structured. Whether you are using Plain's API or not, this is a quick way to get your bearings. | ||
|
||
Within Plain all data belongs to a **Workspace**. When you sign-up you create a workspace. Within a workspace you have **Users**, **Customers**, **Threads**, **Labels**, and **Events**. | ||
|
||
## Workspace | ||
|
||
Everything within Plain happens in a workspace. Typically you will have one workspace using your company's name like you would in Slack or Discord. | ||
|
||
If you want to just try Plain you can make a demo workspace. Demo workspaces have the full functionality of a real workspace but come with a pre-generated support email adress which you can not change. They are also free! | ||
|
||
If you have multiple sub-products or want to have a staging environment with which to build API integrations out you can also create multiple workspaces to do that. (e.g. "Acme Staging" and "Acme Production"). | ||
|
||
## Users | ||
|
||
When you use Plain, you are a user. As user you have one or more roles which define what you are allowed to do within Plain. | ||
|
||
## Customers | ||
|
||
Within Plain you help customers. Each customer has a name ("Grace Hopper"), short name ("Grace") and one email address. Email addresses are unique across all customers. | ||
|
||
Customers are created automatically based on inbound comms or can be created programatically using our API. When created via the API customers can also have an `externalId` which lets you correlate them to customers in your own system. | ||
|
||
Customers can also belong to one or more customer groups. This let's you organise your customer into logical groups such as "Free-tier", "Enterprise", "Design partner", etc. | ||
|
||
## Threads | ||
|
||
Threads are the core of Plain's data model and equivalent to tickets or conversations in other support platforms. | ||
|
||
Each thread belongs to one customer and has a status which is one of `Todo`, `Done` or `Snoozed`. | ||
|
||
When you use Plain to help a customer you assign yourself to a thread and then mark the thread as done once you're done helping. | ||
|
||
Threads are created automatically by inbound communications or programatically via the API, for example when a contact form is submitted. | ||
|
||
Each thread has a timeline. The timeline contains all relevant communication and events as well as a log of all assignment changes etc. | ||
|
||
## Labels | ||
|
||
Labels are a light-weight way of categorising threads by topic (e.g. bugs, feature requests, demo request etc.). A thread can have one or more labels and each label has a name and an icon that you choose in your settings. | ||
|
||
## Events | ||
|
||
Events allow you to log important key actions or events within your own product in Plain. When a customer gets in touch, you will see the events you created on the thread's timeline. | ||
|
||
Events provide you with additional context of the customer's actions when you are helping them. For example if a customer delets an API key and then reaches out regarding 401 errors, then you immediately know the full context. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: 'Alternate addresses' | ||
--- | ||
|
||
TODO |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,8 +2,6 @@ | |
title: 'Receiving emails' | ||
--- | ||
|
||
# Receiving emails in Plain | ||
|
||
To receive emails, you need to set up email forwarding from your company's support email address (e.g. `[email protected]`) | ||
to your Plain workspace's inbound email address. Your workspace's inbound email address ends with `@inbound.postmark.app` and | ||
can be found in under **Settings** → **Email**. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file was deleted.
Oops, something went wrong.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: 'Notifications' | ||
--- | ||
|
||
TODO |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: 'Priorities' | ||
--- | ||
|
||
TODO |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
title: 'Quickstart' | ||
description: 'Get started with Plain in 10 minutes.' | ||
--- | ||
|
||
TODO | ||
|
||
### Feedback & questions | ||
|
||
If you have any feedback on our docs, we'd love to hear it! Open an issue straight in [Github](https://github.com/team-plain/docs) or drop us an email | ||
at [[email protected]](mailto:[email protected]) and an engineer on the team will help you. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: 'Reporting' | ||
--- | ||
|
||
TODO |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,9 @@ | ||
--- | ||
title: 'Security' | ||
description: 'If you or your team have specific questions about how Plain is built, our processes or how we store and handle data please get in touch at [email protected].' | ||
--- | ||
|
||
If you or your team have specific questions about how Plain is built, our processes or how we store and handle data please get in touch at [email protected]. | ||
|
||
We are very happy to answer any questions you have. | ||
|
||
## SOC 2 Type II | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: 'Shortcuts' | ||
--- | ||
|
||
TODO |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
title: 'Slack' | ||
--- | ||
|
||
We're currently iterating and testing bi-directional Slack support internally. | ||
|
||
If you are interested in helping your customers in Slack via Plain please reach out to us at [[email protected]](mailto:[email protected]) so we can discuss and get you set up. | ||
|
||
If you'd prefer, you can also [book a demo with us directly](https://cal.com/team/plain/demo). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: 'Snippets' | ||
--- | ||
|
||
TODO |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: 'Syntax highlighting' | ||
--- | ||
|
||
TODO |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters