Skip to content
Developers/
Other
/
/
ParticipantAddedPayload

GraphQL Overview

Browse queries, mutations, and types in the schema reference. For authentication, endpoint URLs, and domain guides, see the API Overview.

Conversations & messaging

Queries

Overview

Mutations

Overview

Objects

Overview

Enums

Overview
Contacts & CRM

Queries

Overview

Mutations

Overview

Objects

Overview

Inputs

Overview
Products & commerce

Queries

Overview

Mutations

Overview

Objects

Overview
Apps & credentials

Queries

Overview

Mutations

Overview

Objects

Overview
Organization

Queries

Overview

Objects

Overview

Enums

Overview
Other

Queries

Overview

Mutations

Overview

Objects

Overview

ObjectListConfig

key
String
label
String
type
String
Sample
{
  "key": "Example String",
  "label": "Example String",
  "type": "Example String"
}
Referenced in
Field.objectListConfigs

OnboardingHistory

User-level onboarding history and progress

_id
String
userId
String
isCompleted
Boolean
completedSteps
[String]
sections
OnboardingSections
dismissedAt
Date
firstLoginAt
Date
lastActivityAt
Date
Sample
{
  "_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"
}
Referenced in
User.onboardingHistory

OnboardingSection

Section-level completion status for user onboarding

completed
Boolean
completedAt
Date
Sample
{
  "completed": true,
  "completedAt": "Example Custom Scalar"
}
Referenced in
OnboardingSections.essential
OnboardingSections.roleBased
OnboardingSections.discovery

OnboardingSections

Section-level completion tracking for user onboarding

essential
OnboardingSection
roleBased
OnboardingSection
discovery
OnboardingSection
Sample
{
  "essential": {
    "__typename": "OnboardingSection"
  },
  "roleBased": {
    "__typename": "OnboardingSection"
  },
  "discovery": {
    "__typename": "OnboardingSection"
  }
}
Referenced in
OnboardingHistory.sections

PaginationInfo

Standard pagination metadata returned with all paginated list queries.

currentPage
Int!,non-null

The current page number (1-based).

perPage
Int!,non-null

Number of items per page.

totalCount
Int!,non-null

Total number of items matching the query.

totalPages
Int!,non-null

Total number of pages.

hasNextPage
Boolean!,non-null

Whether there are more pages after the current one.

hasPreviousPage
Boolean!,non-null

Whether there are pages before the current one.

Sample
{
  "currentPage": 40,
  "perPage": 40,
  "totalCount": 40,
  "totalPages": 40,
  "hasNextPage": true,
  "hasPreviousPage": true
}
Referenced in
AppListResponse.pagination
BranchListQueryResponse.pagination
CompaniesListResponse.pagination
ConversationListResponse.pagination
ConversationMessageListResponse.pagination
CustomersListResponse.pagination
DepartmentListQueryResponse.pagination
FormsResponse.pagination
FormSubmissionListResponse.pagination
KnowledgeBaseArticlesPaginated.pagination
KnowledgeBaseCategoriesPaginated.pagination
KnowledgeBaseTopicsPaginated.pagination
ProductCategoryListResponse.pagination
ProductListResponse.pagination
TagsPaginatedResponse.pagination
UserListResponse.pagination

ParticipantAddedPayload

Payload for participant_added action.

addedUserId
String
addedUserIds
[String]
viaMention
Boolean
addedUser
User

Resolved user who was added (by addedUserId).

addedUsers
[User]

Resolved users who were added (by addedUserIds).

Sample
{
  "addedUserId": "Example String",
  "addedUserIds": [
    "Example String"
  ],
  "viaMention": true,
  "addedUser": {
    "__typename": "User"
  },
  "addedUsers": [
    {
      "__typename": "User"
    }
  ]
}
Referenced in
ActionsPayload

ParticipantRemovedPayload

Payload for participant_removed action.

removedUserIds
[String]
performedBy
String
removedUsers
[User]

Resolved users who were removed (by removedUserIds).

performedByUser
User

Resolved user who performed the removal.

Sample
{
  "removedUserIds": [
    "Example String"
  ],
  "performedBy": "Example String",
  "removedUsers": [
    {
      "__typename": "User"
    }
  ],
  "performedByUser": {
    "__typename": "User"
  }
}
Referenced in
ActionsPayload

PdfAttachment

A PDF attachment with its individual page images.

pdf
Attachment

The full PDF file.

pages
[Attachment]

Individual page images extracted from the PDF.

Sample
{
  "pdf": {
    "__typename": "Attachment"
  },
  "pages": [
    {
      "__typename": "Attachment"
    }
  ]
}
Referenced in
KnowledgeBaseArticle.pdfAttachment

Position

_id
String!,non-null
title
String
code
String
order
String
parentId
String
parent
Position
status
String
children
[Position]
users
[User]
userIds
[String]
userCount
Int
Sample
{
  "_id": "Example String",
  "title": "Example String",
  "code": "Example String",
  "order": "Example String",
  "parentId": "Example String",
  "parent": {
    "__typename": "Position"
  },
  "status": "Example String",
  "children": [
    {
      "__typename": "Position"
    }
  ],
  "users": [
    {
      "__typename": "User"
    }
  ],
  "userIds": [
    "Example String"
  ],
  "userCount": 40
}
Referenced in
Position.parent
Position.children
User.positions

PriceRange

Min/max price summary for variants.

min
Float
max
Float
currency
String
Sample
{
  "min": 40,
  "max": 40,
  "currency": "Example String"
}
Referenced in
Product.priceRange

PriorityChangedPayload

Payload for priority_changed action.

priority
String
Sample
{
  "priority": "Example String"
}
Referenced in
ActionsPayload

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview