Support conversations

GraphQL schema reference · API guide · SDKs

Support conversations and their messages.

Types used by more than one domain are on Shared types.

Queries

Query.conversation

Fetch a single conversation by ID.

conversation(
  id: ID!
): Conversation

Returns: Conversation (Conversation)

Arguments

• id: ID! — The conversation ID.

SDK

Operation	TypeScript	Go	Python
GetConversation	GetConversationDocument	GetConversation	get_conversation

Query.conversationsConnection

List all support conversations for the current tenant. Conversations are ordered by last activity, most recent first.

conversationsConnection(
  page: ConnectionInput
): ConversationsConnection!

Returns: ConversationsConnection! (ConversationsConnection)

Arguments

• page: ConnectionInput (ConnectionInput) — Pagination options.

SDK

Operation	TypeScript	Go	Python
GetConversationsConnection	GetConversationsConnectionDocument	GetConversationsConnection	get_conversations_connection

Query.messagesConnection

List messages in a conversation. Messages are ordered chronologically, oldest first.

messagesConnection(
  conversationId: ID!
  page: ConnectionInput
): MessagesConnection!

Returns: MessagesConnection! (MessagesConnection)

Arguments

• conversationId: ID! — The conversation ID.
• page: ConnectionInput (ConnectionInput) — Pagination options.

SDK

Operation	TypeScript	Go	Python
GetMessagesConnection	GetMessagesConnectionDocument	GetMessagesConnection	get_messages_connection

Mutations

Mutation.createConversation

Create a new support conversation. Optionally include an initial message.

createConversation(
  input: CreateConversationInput!
): CreateConversationResult!

Returns: CreateConversationResult! (CreateConversationResult)

Arguments

• input: CreateConversationInput! (CreateConversationInput) — Conversation configuration.

SDK

Operation	TypeScript	Go	Python
CreateConversation	CreateConversationDocument	CreateConversation	create_conversation

Mutation.sendMessage

Send a message in an existing conversation. Messages are delivered to support agents in real-time.

sendMessage(
  input: SendMessageInput!
): SendMessageResult!

Returns: SendMessageResult! (SendMessageResult)

Arguments

• input: SendMessageInput! (SendMessageInput) — Message configuration.

SDK

Operation	TypeScript	Go	Python
SendMessage	SendMessageDocument	SendMessage	send_message

Types

ConversationEdge

object

A conversation edge in a connection.

• node: Conversation! (Conversation) — The conversation.
• cursor: String! — Cursor for this edge.

ConversationsConnection

object

Paginated list of conversations.

• edges: [ConversationEdge!]! (ConversationEdge) — List of conversations.
• pageInfo: PageInfo! (PageInfo) — Pagination information.
• totalCount: Int! — Total count of conversations.

CreateConversationInput

input_object

Input for creating a new conversation.

• subject: String — Optional subject line.
• message: String! — Initial message content (required).
• pageUrl: String — Optional page URL where conversation was initiated.

CreateConversationResult

union

• Member: Conversation
• Member: ValidationError
• Member: AuthError

MessageEdge

object

A message edge in a connection.

• node: Message! (Message) — The message.
• cursor: String! — Cursor for this edge.

MessagesConnection

object

Paginated list of messages.

• edges: [MessageEdge!]! (MessageEdge) — List of messages.
• pageInfo: PageInfo! (PageInfo) — Pagination information.
• totalCount: Int! — Total count of messages.

SendMessageInput

input_object

Input for sending a message.

• conversationId: ID! — The conversation ID to send the message to.
• content: String! — The message content.

SendMessageResult

union

• Member: Message
• Member: ValidationError
• Member: NotFoundError
• Member: AuthError