Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.plain.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

UI components are a way of describing some UI when creating threads or events or building customer cards. For example - this is a button that links to Stripe. 
{
  "componentLinkButton": {
    "linkButtonUrl": "http://stripe.com/",
    "linkButtonLabel": "View in Stripe"
  }
}
and it looks like this:
Example button linking to stripe
In the GraphQL API schema, we have two separate unions for Custom Timeline Entry Components and Customer Card Components, but both unions share the same types therefore they can be treated as the same.
Using TypeScript? Check out our UI Components SDK for typed helper functions.
To see UI components in action you can experiment with them in the UI components playground