Skip to content

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

MessageEmail

Email-specific envelope and body data.

subject
String

Email subject line.

integrationId
String

Integration ID this email belongs to.

Sender address(es).

To recipients.

CC recipients.

BCC recipients (only visible to sender).

references
[String]

RFC 5322 References header chain for threading.

htmlBody
String

Sanitized HTML body.

textBody
String

Plain-text fallback body.

snippet
String

Short preview snippet.

Email-native attachment metadata.

newContent
String

Extracted new content (stripped of quoted/replied text).

quotedContent
String

The quoted/replied portion of the email body.

signature
String

Detected email signature block.

Sample
{ "subject": "Example String", "integrationId": "Example String", "from": [ { "__typename": "EmailAddress" } ], "to": [ { "__typename": "EmailAddress" } ], "cc": [ { "__typename": "EmailAddress" } ], "bcc": [ { "__typename": "EmailAddress" } ], "references": [ "Example String" ], "htmlBody": "Example String", "textBody": "Example String", "snippet": "Example String", "attachments": [ { "__typename": "EmailAttachment" } ], "newContent": "Example String", "quotedContent": "Example String", "signature": "Example String" }

MessageEngage

Engage/campaign message content.

messageId
String

The engage message ID.

workspaceId
String

The workspace associated with the engage campaign.

content
String

The campaign content/body.

fromUserId
String

The user who initiated the campaign.

kind
String

Campaign kind.

sentAs
String

How the campaign was sent.

rules

Campaign targeting rules.

Sample
{ "messageId": "Example String", "workspaceId": "Example String", "content": "Example String", "fromUserId": "Example String", "kind": "Example String", "sentAs": "Example String", "rules": "Example Custom Scalar" }

MessageForm

Form submission content.

data

The raw form submission data.

Sample
{ "data": "Example Custom Scalar" }

MessageInteractive

Interactive message (buttons, quick replies, lists, carousels, flows, etc.).

type
String

Interactive type discriminator (button, list, cta_url, carousel, quickReplies, button_reply, list_reply, nfm_reply, etc.).

header

Optional header (text, image, video, document).

body

Body content.

footer

Footer text.

action

Action configuration (buttons, sections, cards, parameters, etc.).

button_reply

Customer button tap reply (incoming).

list_reply

Customer list selection reply (incoming).

nfm_reply

Customer WA Flow / native form submission (incoming).

Sample
{ "type": "Example String", "header": "Example Custom Scalar", "body": "Example Custom Scalar", "footer": "Example Custom Scalar", "action": "Example Custom Scalar", "button_reply": "Example Custom Scalar", "list_reply": "Example Custom Scalar", "nfm_reply": "Example Custom Scalar" }

MessageMedia

Media content attached to a message.

attachments

List of file attachments.

caption
String

Optional caption for the media.

Sample
{ "attachments": [ { "__typename": "Attachment" } ], "caption": "Example String" }

MessageOrder

Order/commerce message content (WhatsApp order flow).

catalogId
String

Commerce catalog identifier.

Products in this order.

text
String

Order summary text.

Sample
{ "catalogId": "Example String", "productItems": [ { "__typename": "MessageOrderProductItem" } ], "text": "Example String" }

MessageOrigin

External origin tracking for a message.

externalId
String

External message ID from the integration platform.

app
String

Origin application identifier.

Sample
{ "externalId": "Example String", "app": "Example String" }

MessageReaction

A reaction on a message.

emoji
String!,non-null

The emoji string.

fromKind
String!,non-null

Who reacted: 'user', 'customer', etc.

fromId
String

The ID of the person who reacted.

Sample
{ "emoji": "Example String", "fromKind": "Example String", "fromId": "Example String" }

MessageSender

Identifies who sent a message.

kind
String!,non-null

Sender kind: 'user', 'customer', 'bot', 'ai_assistant', 'system', 'visitor'.

id
String

The sender's ID (user, customer, bot, etc.).

Sample
{ "kind": "Example String", "id": "Example String" }

MessageSystem

System-generated event shown inline in the conversation.

action
String!,non-null

The action that occurred (e.g. 'assigned', 'status_changed', 'tagged').

Structured action-specific payload based on action type.

label
String

Human-readable label for the event.

Sample
{ "action": "Example String", "payload": { "__typename": "AssignedPayload" }, "label": "Example String" }

MessageTemplate

Template message content.

name
String

Template name.

params

Template parameters (resolved key-value pairs).

language

Template language code.

category
String

Template category (MARKETING, UTILITY, AUTHENTICATION).

Pre-rendered snapshot of what the customer received.

Sample
{ "name": "Example String", "params": "Example Custom Scalar", "language": "Example Custom Scalar", "category": "Example String", "rendered": { "__typename": "TemplateRendered" } }

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview