API Reference

ⓘ

Who can use this feature?

Available to all users on any plan.

Overview

Chatty gives developers several 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 and write live chat conversations, messages, tags, and notes.
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

All API credentials live in one place: Settings > General > Manage keys.

Create an API key

Enter a name in Key name — name it after the tool that will use it, for example Zendesk sync. The name can be up to 50 characters. Then click Generate key.

The Manage keys panel with the Key name field and the Generate key button

The new key appears in your list with the full sk_ value visible.

The new key shown in full, with a banner reminding you to copy it now

Copy the key before you leave the page. Chatty stores only a hash of it, so the full key can never be shown again. If you lose it, delete the key and create a new one.

You can keep up to 5 active keys per store. Create one per integration so you can delete a single key without breaking the others. Deleting a key takes effect within about 5 minutes.

ⓘ

Creating and managing keys requires the Pro or Plus plan. On other plans the panel is replaced by a note with an upgrade link.

Find your App ID

Your App ID sits at the top of the same panel. Some tools call it a Client ID. It identifies your store, and some integrations need it alongside your key.

The App ID field at the top of the Manage keys panel

Which credential each API expects

API	Send
Chat Conversations API	`X-Api-Key: sk_...`
Webhooks management	`X-Api-Key: sk_...`
GraphQL Customer API	`x-api-id` (App ID) and `x-api-secret` (your key)

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