Ticket Widgets
Ticket Widget: Overview
Learn what a ticket widget is, what it can do inside a ticket, and how it differs from Dynamic Content. Start here to find the right article for what you want to build.
How the Widget Is Requested
The Tokity UI calls your widget API to load and update a widget. Learn what each request contains, including the ticket, the reader, form and state, and how to identify the user.
Ticket Widget Anatomy and Styling
Learn the parts every ticket widget shares: icon, title, Markdown description, border and title colours, and collapse. See how each one affects the look of your widget and how long text is truncated.
Ticket Widget Actions: Leading, Secondary and Primary
Learn how to add leading, secondary and primary actions to a ticket widget. See where each one appears, which ones can submit a form, and how to use a button, a dropdown or a split button.
Ticket Widget: Progress Type
Learn how to construct your API response to render a ticket widget as a progress list, showing the status of each step in a process.
Ticket Widget: List Type
Learn how to construct your API response to render a ticket widget as a list of items that users can select, open or follow as a link.
Ticket Widget: Description Type
The Description type shows rows of labels and values, such as requester, cost or due date. Learn how to structure the response and what happens to long text.
Ticket Widget: Form Type
Learn how to construct your API response to render a ticket widget that interacts with the user, by asking them to make a choice.
Ticket Widget: Control When a Widget Refreshes
Choose how a widget updates itself: on change, on a timer, both, or manually. Learn the intervals and limits, and when to use each mode.
Ticket Widget: Form Results and State Across Steps
The form and state properties let your API pass data between steps without storing it. Learn what the UI sends back, how a reload resets it, and how to keep progress.
Ticket Widget: Error Responses and Debugging
Learn which responses count as errors, the error format to return, and what users see. It also covers how to debug a widget by saving and reading the network record.
Ticket Widget: Building a Multi-Step Request
Learn how to design a multi-step ticket widget API. Detect the first load, tell apart each action, and keep the user's answers between steps and across a reload.
