Types Reference

Use this page when

Use this page as the shared type index behind the Support docs.

• you want the exact shape of a prop, event payload, or shared model
• a guide links to a named type like TimelineItem, Conversation, or PublicVisitor
• you are building custom UI on top of hooks, events, or primitives

If you are still deciding how to shape the widget, start with Overview, Change One Thing, or Pages & Layouts.

Widget Types

DefaultMessage

Structure for pre-conversation welcome messages.

VisitorMetadata

Key-value pairs for storing custom data about contacts.

SenderType

Enum defining who can send messages.

SupportMode

Layout mode for the widget.

Copytype SupportMode = "floating" | "responsive";

TriggerRenderProps

Props provided to custom trigger render functions.

SupportHandle

Imperative handle for programmatic widget control via refs.

Visitor And Website Data

PublicVisitor

The visitor object returned by the widget, representing an anonymous or identified visitor.

PublicContact

Contact information for an identified visitor.

PublicWebsiteResponse

Website configuration and agent availability information.

HumanAgent

Information about a human support agent.

AIAgent

Information about an AI support agent.

Conversations And Messages

Conversation

Conversation record used throughout the support widget and event payloads.

TimelineItem

Timeline item payload used for widget messages, events, and AI tool output.

Hook And Event Types

IdentifyParams

Parameters for the identify() function.

MessageComposer

State and actions returned by useConversationPage for message composition.

SupportEvent

Union type of all possible widget events.

Client Types

CossistantClient

The low-level client instance for advanced programmatic control. The table below highlights the main public stores and methods exposed by the client.