Introduction
Welcome
Quickstart
Identifying Yourself as an App User
GraphQL
API
Working with GraphQL
Pagination
Rate limiting
Common Api Queries
Introduction
List All Conversations
Fetch A Single Conversation
List All Contacts
Attaching a File to a Message
Webhooks
Introduction
Conversation created
Conversation opened
Conversation closed
Conversation assigned
Conversation snoozed
Message created
Message updated
Mention created
Channel user created
Conversation tag created
Conversation tag deleted
Channel user tag created
Channel user tag deleted
Chatbot flow started
Chatbot flow ended
Whatsapp flow response state created
Useful Scripts
Introduction
Finding A Single Conversation
Exporting All Conversations
Bulk Assigning Conversations to a Teammate
REST API
Check our REST API Docs
Queries
app
currentAppUser
Mutations
appUpdate
attachmentImageUploadFromUrl
attachmentUpload
attachmentUploadFromUrl
attachmentVideoUploadFromUrl
channelUserCreate
channelUserDataAttributeBoolUpdate
channelUserDataAttributeDateUpdate
channelUserDataAttributeDecimalUpdate
channelUserDataAttributeNumberUpdate
channelUserDataAttributeSelectUpdate
channelUserDataAttributeTextUpdate
channelUserIdentifierUpdate
channelUserTag
channelUserTagByTagId
channelUserUntag
channelUserUpdate
conversationAssign
conversationClose
conversationOpen
conversationSetState
conversationSnooze
conversationTag
conversationTagByTagId
conversationTeamAssign
conversationUnsnooze
conversationUntag
dataAttributeArchive
dataAttributeBatchCreate
dataAttributeCreate
gifMessageCreate
mediaMessageCreate
messageDelete
messageRetrySend
noteMessageCreate
richMessageCreate
sandboxAddTester
sandboxRemoveTester
templateDelete
templateMessageCreate
templateProactiveMessageCreate
templateSetActive
templateSubmit
templateUpdate
templatesSync
textMessageCreate
textProactiveMessageCreate
webhookSubscriptionCreate
webhookSubscriptionDestroy
webhookSubscriptionUpdate
workflowBotSend
workflowBotSendProactive
Types
AbmInputObject
Account
ActionTypeUnion
AiFeedbackMessage
AiFeedbackMessageDetailsNegative
AiFeedbackMessageDetailsPositive
AiFeedbackMessageNegativeReasonEnum
AiSummaryMessage
Analytics
AnimationMessage
App
AppConnection
AppEdge
AppUpdateInput
AppUser
AppUserConnection
AppUserEdge
AppUserNotificationMethodEnum
AppUserNotificationPreference
AppUserNotificationTypeEnum
AppUserPresenceEnum
AppUserRoleEnum
AppUserRolePermissionEnum
AppUserStatusEnum
AssignmentActionMessage
Attachment
AttachmentConnection
AttachmentEdge
AttachmentImageUploadFromUrlInput
AttachmentImageUploadFromUrlPayload
AttachmentTypeEnum
AttachmentUploadFromUrlInput
AttachmentUploadFromUrlPayload
AttachmentUploadInput
AttachmentUploadPayload
AttachmentVideoUploadFromUrlInput
AttachmentVideoUploadFromUrlPayload
AttributeInputObject
AttributeSelectOptionInputObject
AudioMessage
BigInt
Boolean
BotUser
BotUserConnection
BotUserEdge
CampaignFilterInputObject
CampaignQueryInputObject
Channel
ChannelConnection
ChannelEdge
ChannelHealthDefaultMetadata
ChannelHealthIssue
ChannelHealthIssueCategoryEnum
ChannelHealthIssueSeverityEnum
ChannelHealthMetadataWhatsappGatewayStatusEnum
ChannelHealthMetadataWhatsappPhoneStatusTypeEnum
ChannelHealthMetadataWhatsappQualityEnum
ChannelHealthMetadataWhatsappTierEnum
ChannelHealthStatus
ChannelHealthWhatsappMetadata
ChannelTypeEnum
ChannelUser
ChannelUserConnection
ChannelUserCreateInput
ChannelUserDataAttribute
ChannelUserDataAttributeArchiveInput
ChannelUserDataAttributeBatchCreateInput
ChannelUserDataAttributeBoolType
ChannelUserDataAttributeConnection
ChannelUserDataAttributeCreateInput
ChannelUserDataAttributeDateType
ChannelUserDataAttributeDecimalType
ChannelUserDataAttributeEdge
ChannelUserDataAttributeEmailType
ChannelUserDataAttributeMultiSelectType
ChannelUserDataAttributeNumberType
ChannelUserDataAttributePhoneType
ChannelUserDataAttributeSelectOptionType
ChannelUserDataAttributeSelectType
ChannelUserDataAttributeTextType
ChannelUserDataAttributeUrlType
ChannelUserEdge
ChannelUserFilterableChannelIdInputObject
ChannelUserFilterableCompanyInputObject
ChannelUserFilterableCreatedAtInputObject
ChannelUserFilterableDataAttributeBoolInputObject
ChannelUserFilterableDataAttributeDateInputObject
ChannelUserFilterableDataAttributeDecimalInputObject
ChannelUserFilterableDataAttributeNumberInputObject
ChannelUserFilterableDataAttributeSelectInputObject
ChannelUserFilterableDataAttributeTextInputObject
ChannelUserFilterableEmailInputObject
ChannelUserFilterableIntegrationImportIdInputObject
ChannelUserFilterableNameInputObject
ChannelUserFilterableOptOutInputObject
ChannelUserFilterableOwnerInputObject
ChannelUserFilterablePhoneInputObject
ChannelUserFilterableStageInputObject
ChannelUserFilterableTagIdInputObject
ChannelUserIdentifierSourceEnum
ChannelUserIdentifierUpdateInput
ChannelUserNote
ChannelUserSourceIdentifier
ChannelUserTagByTagIdInput
ChannelUserTagInput
ChannelUserUntagInput
ChannelUserUpdateInput
Company
CompanyStateEnum
ComponentButtonInputObject
ComponentInputObject
ConditionTypeUnion
ConditionableChannelUsersCreatedAtType
ConditionableChannelUsersDataAttributesType
ConditionableChannelUsersStandardDataAttributesType
ConditionableChannelUsersTagType
ConditionableConversationsTagType
ConditionableMessagesDirectionMultipleType
ConditionableMessagesDirectionSingleType
ConditionableMessagesKeywordMultipleType
ConditionableMessagesTimeframeScheduleType
ConditionableMessagesTimeframeType
ContactEntry
ContactIm
ContactMessage
Conversation
ConversationAssignmentInput
ConversationAssignmentPayload
ConversationCloseInput
ConversationClosePayload
ConversationConnection
ConversationEdge
ConversationOpenInput
ConversationOpenPayload
ConversationOrderTypeEnum
ConversationParticipant
ConversationSession
ConversationSessionConnection
ConversationSessionEdge
ConversationSetStateInput
ConversationSetStatePayload
ConversationSnoozeInput
ConversationSnoozePayload
ConversationStateEnum
ConversationTagByTagIdInput
ConversationTagInput
ConversationTeamAssignmentInput
ConversationTeamAssignmentPayload
ConversationUnsnoozeInput
ConversationUnsnoozePayload
ConversationUntagInput
DataAttribute
DataAttributeBoolType
DataAttributeBoolUpdateInput
DataAttributeDateType
DataAttributeDateUpdateInput
DataAttributeDecimalType
DataAttributeDecimalUpdateInput
DataAttributeNumberType
DataAttributeNumberUpdateInput
DataAttributeSelectType
DataAttributeSelectUpdateInput
DataAttributeTextType
DataAttributeTextUpdateInput
DataAttributeTypeEnum
DataAttributesFilterTypeUnion
DeletedMessage
DetailsUnion
DocumentMessage
EmailMessageMeta
EntityNote
EntityNoteEdit
EntityTypeEnum
EntityUnion
FacebookInputObject
Failure
FailureNextStep
Fallback
Field
FileInputObject
FilteringArrayInclusionOperatorEnum
FilteringBooleanOperatorEnum
FilteringDateOperatorEnum
FilteringExactEqualityOperatorEnum
FilteringInclusionOperatorEnum
Float
Flow
FlowMessage
FlowResponseEntry
FlowResponseMessage
HubspotContact
HubspotProperties
ImageMessage
InboxViewBooleanOperatorEnum
InboxViewFilterInputObject
InboxViewFilterableAssigneeIdInputObject
InboxViewFilterableChannelIdInputObject
InboxViewFilterableChannelTypeInputObject
InboxViewFilterableConversationIdInputObject
InboxViewFilterableConversationStateInputObject
InboxViewFilterableCreatedAtInputObject
InboxViewFilterableLastMessageAtInputObject
InboxViewFilterableParticipantInputObject
InboxViewFilterableSnoozedUntilInputObject
InboxViewFilterableTagIdInputObject
InboxViewFilterableTeamIdInputObject
InboxViewMessagingWindowInputObject
InboxViewQueryInputObject
InstagramInputObject
Int
InteractionTypeUnion
InteractiveMessage
InteractiveMessageHeader
InteractiveMessageMediaHeader
InteractiveMessageTextHeader
InternalReaction
JSON
LanguageEnum
List
ListMessage
ListSection
ListSectionRow
LocationMessage
MdString
Mention
MentionConnection
MentionEdge
Message
MessageCategoryEnum
MessageConnection
MessageContactIMTypeEnum
MessageCreatedTrigger
MessageDeleteInput
MessageDeletePayload
MessageDirectionEnum
MessageEdge
MessageFacebookTagEnum
MessageFormatEnum
MessageGifCreateInput
MessageGifCreatePayload
MessageInstagramTagEnum
MessageMediaCreateInput
MessageMediaCreatePayload
MessageNoteCreateInput
MessageNoteCreatePayload
MessageProactiveTemplateCreateInput
MessageProactiveTemplateCreatePayload
MessageProactiveTextCreateInput
MessageProactiveTextCreatePayload
MessageQuickReplyTypeEnum
MessageRetrySendInput
MessageRetrySendPayload
MessageRichCreateInput
MessageRichCreatePayload
MessageSubTypeEnum
MessageTemplate
MessageTemplateCategoryEnum
MessageTemplateComponent
MessageTemplateComponentButton
MessageTemplateComponentButtonTypeEnum
MessageTemplateComponentFormatEnum
MessageTemplateComponentTypeEnum
MessageTemplateComponentWithVariablesTypeEnum
MessageTemplateConnection
MessageTemplateCreateInput
MessageTemplateCreatePayload
MessageTemplateCreationComponentInputObject
MessageTemplateCreationComponentParameterInputObject
MessageTemplateCreationComponentParameterTypeEnum
MessageTemplateCreationComponentSubtypeEnum
MessageTemplateDataAttributeInputObject
MessageTemplateDeleteInput
MessageTemplateDeletePayload
MessageTemplateDynamicVariables
MessageTemplateDynamicVariablesInputObject
MessageTemplateEdge
MessageTemplateLanguageEnum
MessageTemplateSetActiveInput
MessageTemplateSetActivePayload
MessageTemplateStateEnum
MessageTemplateSubmitInput
MessageTemplateSubmitPayload
MessageTemplateUpdateInput
MessageTemplateUpdatePayload
MessageTemplateVariableFillDataAttribute
MessageTemplatesSyncInput
MessageTemplatesSyncPayload
MessageTextCreateInput
MessageTextCreatePayload
MessageTypeEnum
MessageWindowExpiryCondition
MessageWindowExpiryConditionEnum
MessagingWindowStatusTypeEnum
MetadataTypeUnion
Mutation
Node
NodeFallback
NoteEntityUnion
NoteMessage
PageInfo
Phone
PinnedMessage
PlatformWebhookSubscriptionCreateInput
PlatformWebhookSubscriptionDestroyInput
PlatformWebhookSubscriptionDestroyPayload
PlatformWebhookSubscriptionUpdateInput
Position2D
PrimitiveArrayValue
PrimitiveValue
ProactiveTrigger
Properties
PropertiesBoolType
PropertiesConnection
PropertiesDateType
PropertiesEdge
PropertiesEmailType
PropertiesEntityType
PropertiesMultiSelectType
PropertiesNumberType
PropertiesPhoneType
PropertiesSelectType
PropertiesTextType
PropertiesUrlType
Query
QuickReply
QuickReplyInputObject
QuickReplyMessage
ReactionableUnion
RegexpOperatorEnum
RichMessage
Role
SandboxAddTesterInput
SandboxAddTesterPayload
SandboxConnectedTester
SandboxRemoveTesterInput
SandboxRemoveTesterPayload
SavedReply
SavedReplyConnection
SavedReplyEdge
SavedReplyFolder
SavedReplyLeafUnion
SegmentTypeUnion
Shift
SnoozeActionMessage
StateActionMessage
StatusCodeUnion
String
Tag
TagConnection
TagEdge
Team
TeamDayScheduleType
TeamMembership
TeamScheduleType
TeamsAssignmentOptionEnum
TemplateButton
TemplateMessage
TemplateParameter
TemplateVariableDefaultType
TextMessage
Timezone
TriggerUnion
TriggerableUnion
UnsnoozeActionMessage
UnsupportedMessage
UploadInformation
Url
User
VariableTypeUnion
VideoMessage
WebhookEventTypeEnum
WebhookSubscription
WebhookSubscriptionConnection
WebhookSubscriptionEdge
WeekDaysEnum
WhatsappFlow
WhatsappFlowFieldTypeEnum
WhatsappFlowStateEnum
WhatsappFlowTypeEnum
WorkflowBot
WorkflowBotAnalytics
WorkflowBotAssignConversationAction
WorkflowBotBranchAnalytics
WorkflowBotConnection
WorkflowBotContentSegmentsType
WorkflowBotDataAttributeVariableType
WorkflowBotEdge
WorkflowBotExecuteNodeAction
WorkflowBotFallbackInvalidFreeFormReply
WorkflowBotFallbackInvalidSelectedOptionCount
WorkflowBotFallbackNoReplyWithinTime
WorkflowBotFlowMessageEventEnum
WorkflowBotFlowVariableType
WorkflowBotHttpRequestsMethodEnum
WorkflowBotHttpRequestsStatusCodeGenericEnum
WorkflowBotHttpRequestsVariableDataTypeEnum
WorkflowBotMentionTypeEnum
WorkflowBotMessageComponentTypeEnum
WorkflowBotNodeAIDetectIntent
WorkflowBotNodeAIDetectIntentCategory
WorkflowBotNodeAction
WorkflowBotNodeAiMessage
WorkflowBotNodeAiMessageHandoverType
WorkflowBotNodeAiSmartCapture
WorkflowBotNodeAiSmartCaptureField
WorkflowBotNodeAnalytics
WorkflowBotNodeAssignHubspotOwner
WorkflowBotNodeDecision
WorkflowBotNodeDecisionConditionGroup
WorkflowBotNodeDecisionConditionTypeUnion
WorkflowBotNodeDelay
WorkflowBotNodeExecuteNode
WorkflowBotNodeFallbackInvalidFreeFormReply
WorkflowBotNodeFallbackNoReplyWithinTime
WorkflowBotNodeFallbackUnknownHubspotOwner
WorkflowBotNodeFlowMessage
WorkflowBotNodeFlowMessageEventTargetNodeType
WorkflowBotNodeFlowMessageResponseVariableExtractionRuleType
WorkflowBotNodeHttpRequest
WorkflowBotNodeHttpRequestHeaderType
WorkflowBotNodeHttpRequestQueryParams
WorkflowBotNodeHttpRequestResponseVariableExtractionRuleType
WorkflowBotNodeHttpRequestStatusCodeGenericType
WorkflowBotNodeHttpRequestStatusCodeSpecificType
WorkflowBotNodeHttpRequestStatusCodeTargetNodeType
WorkflowBotNodeHttpRequestTestResponseType
WorkflowBotNodeInteractionList
WorkflowBotNodeInteractionListSection
WorkflowBotNodeInteractionListSectionRow
WorkflowBotNodeInteractionQuickReplies
WorkflowBotNodeInteractionQuickReply
WorkflowBotNodeMessage
WorkflowBotNodeMessageVariable
WorkflowBotNodeNote
WorkflowBotNodeProactiveTemplateMessage
WorkflowBotNodeSimpleMessage
WorkflowBotNodeTemplateMediaParameterType
WorkflowBotNodeTemplateMessage
WorkflowBotNodeTemplatePhoneButton
WorkflowBotNodeTemplateTextButton
WorkflowBotNodeTemplateTextParameterType
WorkflowBotNodeTemplateUrlButton
WorkflowBotNodeTextAnnotation
WorkflowBotNodeUserInput
WorkflowBotNodeWaitForResponse
WorkflowBotProactiveSendInput
WorkflowBotProactiveSendPayload
WorkflowBotResendLastMessageAction
WorkflowBotSegmentsMentionType
WorkflowBotSegmentsTextType
WorkflowBotSendInput
WorkflowBotSendPayload
WorkflowBotStateAnalytics
WorkflowBotStateEnum
WorkflowBotSystemVariableType
WorkflowBotTagContactAction
WorkflowBotTagConversationAction
WorkflowBotTeamAssignConversationAction
WorkflowBotUpdateConversationStateAction
WorkflowBotVariableSystemVariableNameEnum
WorkflowBotVersion
WorkflowBotsInteractiveMessageHeaderUnion
WorkflowBotsInteractiveMessageMediaHeader
WorkflowBotsInteractiveMessageTextWithVariablesHeader
WorkflowTriggersConditionablesChannelUserDataAttributeMultipleType
WorkflowTriggersConditionablesChannelUserDataAttributeSingleType
WorkflowTriggersConditionablesFlowVariablesMultipleType
WorkflowTriggersConditionablesFlowVariablesSingleType
WorkflowTriggersConditionablesSystemVariablesMultipleType
WorkflowTriggersConditionablesSystemVariablesSingleType
WorkflowTriggersFlowVariableMultipleOperatorEnum
WorkflowTriggersFlowVariableSingleOperatorEnum
WorkflowTriggersTriggerTypeEnum
WorkspaceUserUnion
ComponentButtonInputObject
Input Object
Fields
#
exampleVariables
[
String
!]
otpType
String
phoneNumber
String
text
String
!
Non-null
type
MessageTemplateComponentButtonTypeEnum
!
Non-null
url
String
Previous
CompanyStateEnum
Next
ComponentInputObject
