Plain Docs

Docs

• Building Agents on Plain
• Acting on threads: The actions your agent can take on a thread.
• Machine users: Set up your agent's identity in Plain.
• Reading threads: Fetch thread context for your agent to act on.
• Receiving events: Listen for thread and message events with webhooks.
• Routing to your agent: Decide which threads your agent should act on.
• Searching knowledge: Give your agent answers from your help center and indexed documents.
• Customer cards: Live context straight from your own systems when helping customers.
• Create a customer card: Define the details of the customer card.
• Examples
• Playground
• Protocol: Learn how we request customer cards from your API and how to respond to these requests.
• API Explorer
• Attachments: How to upload attachments programmatically for messages and events in Plain.
• Authentication
• Companies
• Delete a company
• Fetch companies
• Update customer company
• Upsert a company
• Customers
• Customer groups
• Delete customers
• Fetch customers
• Mark customer as spam
• Upserting customers: Learn how to create and update customers programmatically.
• Discussions
• Start a discussion
• Fetch discussions
• Send a discussion message
• Error codes: If you receive an error code as part of an API call, this is where you can look up what it means
• Error handling: GraphQL queries and mutations require different error handling.
• Events: Log important events to have the full picture of what happened in Plain.
• Create a customer event
• Create a thread event
• Help center
• Fetch help centers and articles
• Manage article groups
• Manage articles
• Manage the navigation
• Introduction: An overview of Plain's GraphQL API.
• Labels
• Add labels
• Manage label types
• Remove labels
• Messaging
• Reply to emails
• Reply to threads
• Send new emails
• Suggested replies
• Notes
• Pagination
• Schema
• GraphQL SDK: A typed SDK for Plain's GraphQL API, auto-generated from the schema.
• Snippets
• Create a snippet
• Delete a snippet
• Fetch snippets
• Update a snippet
• Tasks
• Create a task
• Delete a task
• Fetch tasks
• Update a task
• Tenants
• Add customers to tenants
• Delete a tenant
• Get tenants
• Remove customers to tenants
• Set customer tenants
• Tenant fields
• Upserting tenants
• Threads
• Assignment
• Autoresponders
• Create threads
• Delete a thread
• Escalating threads
• Fetch threads
• Importing threads
• Changing status
• Thread fields
• Update thread attributes
• Tiers & SLAs
• Add companies and tenants to tiers
• Get tiers
• Remove companies and tenants to tiers
• Service level agreements
• Update company tier
• Update tenant tier
• Webhook targets
• Create a webhook target
• Delete a webhook target
• Inspect delivery attempts
• Fetch webhook targets
• Update a webhook target
• mTLS
• Request signing
• UI Components
• Badge: Useful for statuses or when you need to attract attention to something.
• Container: Useful when you need to create a bit of structure.
• CopyButton: Useful if you have any IDs or other details you want to copy for use in messages or outside of Plain.
• Divider: Useful when you need a bit of structure.
• LinkButton: Useful when you want to link somewhere external (e.g. your own admin tool or payment provider)
• PlainText: Useful when you want to show any text that should not have any formatting (is not Markdown). If you want markdown please use Text.
• Row: Useful when you need to show two things next to each-other.
• UI Components SDK: Helper functions for building Plain UI components with full type safety.
• Spacer
• Text
• WorkflowButton: Useful when you want to let agents trigger a workflow directly from a customer card
• Webhooks
• Customer created
• Customer deleted
• Customer Group Membership Changed Event
• Customer updated
• Webhooks SDK: Webhook parsing and signature verification for Plain webhooks.
• Thread assignment transitioned
• Chat received
• Chat sent
• Thread created
• Email received
• Email sent
• Thread Field created
• Thread Field deleted
• Thread Field updated
• Thread labels changed
• Note created
• Thread priority changed
• Thread SLA status transitioned
• Slack message received
• Slack message sent
• Thread status transitioned
• Webhook Versions