Schema

Changelog

Blog

Book a demo

Plain Docs

API Reference

Sign in

@plainsupport

Chat sent

Everything you need to know to start supporting your customers with Plain.

Quickstart

A quick overview of how Plain is structured.

Data model

Security

Overview

Email

Receiving emails

Sending emails

Alternate addresses

Slack

Ingestion Modes

Data Retention

Contact forms

Give your customers visibility over their support requests.

Headless portal

Headless Support Portal

Notifications

Assignment

Tiers & SLAs

Priorities

Labels

Syntax highlighting

Insights

Snippets

Shortcuts

Auto-responses

Plain AI

Broadcasts

Roles & Permissions

Linear integration

Salesforce importer

Zendesk importer

Discourse Integration

Companies

Tenants

Thread Fields

Thread Discussions

Live context straight from your own systems when helping customers.

Customer cards

Customer groups

Get the full picture of what happened and why straight in Plain.

Events

Introduction

Authentication

Customers

Fetch customers

Learn how to create and update customers programmatically.

Upserting customers

Delete customers

Get companies

Update customer company

Upserting tenants

Get tenants

Add customers

Add customers to tenants

Remove customers

Remove customers to tenants

Set customer tenants

Threads

Create threads

Thread fields

Changing status

Get tiers

Update company tier

Update tenant tier

Add companies & tenants

Add companies and tenants to tiers

Remove companies & tenants

Remove companies and tenants to tiers

Log important events to have the full picture of what happened in Plain.

Create a customer event

Create a thread event

Add labels

Remove labels

Messaging

Reply to threads

Send new emails

Reply to emails

Pagination

GraphQL queries and mutations require different error handling.

Error handling

If you receive an error code as part of an API call, this is where you can look up what it means

Error codes

API Explorer

Typescript SDK

Create a customer card

Learn how we request customer cards from your API and how to respond to these requests.

Protocol

Playground

Examples

Webhooks

Using Typescript

Webhooks and Typescript

Thread created

Thread status transitioned

Thread assignment transitioned

Thread labels changed

Thread priority changed

Note created

Email received

Email sent

Slack message received

Slack message sent

Thread Field created

Thread Field updated

Thread Field deleted

Thread SLA status transitioned

Customer created

Customer updated

Customer deleted

Customer Group Membership Changed Event

UI Components

Useful for statuses or when you need to attract attention to something.

Badge

Useful when you need to create a bit of structure.

Container

Useful if you have any IDs or other details you want to copy for use in messages or outside of Plain.

CopyButton

Divider

Useful when you want to link somewhere external (e.g. your own admin tool or payment provider)

LinkButton

Useful when you want to show any text that should not have any formatting (is not Markdown). If you want markdown please use [Text](/api-reference/ui-components/text).

GraphQL

Reference

​Schema

Schema