API Reference

ⓘ

Who can use this feature?

Available to all users on any plan.

Overview

Chatty gives developers three ways to build on top of your store's chat and customer data:

Tool	Use it to…
GraphQL Customer API	Read contacts and customer data — sync to a CRM, BI tool, or email platform.
Chat Conversations API	Read live chat conversations and messages (beta).
Webhooks	Get notified in real time when the AI replies or a customer messages.
Storefront SDK	Control the chat widget from your storefront — open it, send messages, track events.

If you're looking for ready-made integrations without code, see Klaviyo, Zendesk, or Joy instead.

Generate your API key

Go to Settings > API in your Chatty dashboard.

Click Generate key. You'll immediately see two credentials:

Credential	What it's for
App ID	Your store identifier. Include this in every API request.
Secret key	Your private authentication key. Never share this publicly.

Copy your Secret key right away. It's only shown once. If you lose it, you'll need to generate a new one — which immediately deactivates the old key.

If your key is ever compromised, click Generate key again to rotate it. The previous key stops working instantly.

These same credentials authenticate both the GraphQL Customer API and the Webhooks management API.

What you can build

Export contacts to a spreadsheet
Use the GraphQL customers query with pagination to pull all contacts, then write them to a CSV.

Sync high-value customers to an email platform
Filter by totalSpent and push matching customers to your email tool via its own API.

Route unanswered questions to a human
Subscribe to the ai_response webhook and alert your team whenever isAskBotResponse is "not-found".

Embed chat actions in your storefront
Use the SDK to open the chatbox from a custom button or prefill a message.

Need help?

If you run into issues with your API key or requests, contact the Chatty support team from your dashboard.

Index GraphQL Customer API