UI components

Describe UI declaratively when creating threads, events, and customer cards.

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:

In the GraphQL API schema there are 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.

For TypeScript, the UI components SDK provides typed helpers for building these.

To see UI components in action you can experiment with them in the UI components playground