- ObjectListConfig
Browse queries, mutations, and types in the schema reference. For authentication, endpoint URLs, and domain guides, see the API Overview.
Identifies who sent a message.
Sender kind: 'user', 'customer', 'bot', 'ai_assistant', 'system', 'visitor'.
The sender's ID (user, customer, bot, etc.).
{ "kind": "Example String", "id": "Example String" }
System-generated event shown inline in the conversation.
The action that occurred (e.g. 'assigned', 'status_changed', 'tagged').
Structured action-specific payload based on action type.
Human-readable label for the event.
{ "action": "Example String", "payload": { "__typename": "AssignedPayload" }, "label": "Example String" }
Template message content.
Template name.
Template parameters (resolved key-value pairs).
Template language code.
Template category (MARKETING, UTILITY, AUTHENTICATION).
Pre-rendered snapshot of what the customer received.
{ "name": "Example String", "params": "Example Custom Scalar", "language": "Example Custom Scalar", "category": "Example String", "rendered": { "__typename": "TemplateRendered" } }
Plain-text or rich-text message body.
The message body content.
An optional short preview for long messages.
{ "body": "Example String", "preview": "Example String" }
Video call message content.
URL to join the video call.
Current call status.
Provider name (e.g. 'dailyco').
{ "url": "Example String", "status": "Example String", "provider": "Example String" }
{ "key": "Example String", "label": "Example String", "type": "Example String" }
User-level onboarding history and progress
{ "_id": "Example String", "userId": "Example String", "isCompleted": true, "completedSteps": [ "Example String" ], "sections": { "__typename": "OnboardingSections" }, "dismissedAt": "Example Custom Scalar", "firstLoginAt": "Example Custom Scalar", "lastActivityAt": "Example Custom Scalar" }
Section-level completion status for user onboarding
{ "completed": true, "completedAt": "Example Custom Scalar" }
Section-level completion tracking for user onboarding
{ "essential": { "__typename": "OnboardingSection" }, "roleBased": { "__typename": "OnboardingSection" }, "discovery": { "__typename": "OnboardingSection" } }
Standard pagination metadata returned with all paginated list queries.
The current page number (1-based).
Number of items per page.
Total number of items matching the query.
Total number of pages.
Whether there are more pages after the current one.
Whether there are pages before the current one.
{ "currentPage": 40, "perPage": 40, "totalCount": 40, "totalPages": 40, "hasNextPage": true, "hasPreviousPage": true }
Payload for participant_added action.
{ "addedUserId": "Example String", "addedUserIds": [ "Example String" ], "viaMention": true, "addedUser": { "__typename": "User" }, "addedUsers": [ { "__typename": "User" } ] }