# Popcorn Documentation

- [Popcorn Documentation](https://docs.trypopcorn.ai/introduction.md): Learn what Popcorn does for your store and find the guide for each part of the app, from setup to campaigns and billing.
- [Quickstart](https://docs.trypopcorn.ai/quickstart.md): Create your account, then set up your agent in three steps: your business, what it knows, and WhatsApp. Then watch its first conversation.
- [How Popcorn works](https://docs.trypopcorn.ai/how-popcorn-works.md): Understand the pieces of Popcorn: workspace, agents, channels, Knowledge, Inbox, campaigns, credits, and roles.
- [Connect your store](https://docs.trypopcorn.ai/integrations/overview.md): What connecting Shopify, Salla or Zid to Popcorn unlocks, the one-active-store rule, and the Connect, Reconnect, Settings and Resync actions.
- [Connect Shopify](https://docs.trypopcorn.ai/integrations/shopify.md): Connect your Shopify store, understand what syncs, set phone-only checkout and custom checkout fields, and see which events drive campaigns.
- [Connect Salla](https://docs.trypopcorn.ai/integrations/salla.md): Connect your Salla store, see what syncs, sync shipping methods, which events trigger campaigns, and how the Salla App Store subscription applies.
- [Connect Zid](https://docs.trypopcorn.ai/integrations/zid.md): Connect your Zid store from Popcorn or the Zid App Market, see what syncs, set VAT, payments and shipping, and how the Zid subscription works.
- [Meta Business catalog](https://docs.trypopcorn.ai/integrations/meta-business.md): How the Meta Business row on Integrations leads to Products in WhatsApp, and what Popcorn keeps in sync once a Meta catalog is connected.
- [Store health](https://docs.trypopcorn.ai/integrations/commerce-health.md): Read the Store health panel on Integrations: overall score, the five categories, statuses, problems and what to do about each.
- [Integration troubleshooting](https://docs.trypopcorn.ai/integrations/troubleshooting.md): Fix store connection problems: reconnecting, stale catalogs, no shipping option, required options, duplicate stores, rate limits and tracking.
- [Channels overview](https://docs.trypopcorn.ai/channels/overview.md): Understand the WhatsApp and Website chat channels, how a number reaches an agent, what the default number does, and how to test on the sandbox.
- [Connect a WhatsApp number](https://docs.trypopcorn.ai/channels/whatsapp.md): Connect your WhatsApp Business number through Meta's window, then manage connected numbers, the default number, message limits and reconnects.
- [WhatsApp business profile](https://docs.trypopcorn.ai/channels/whatsapp-profile.md): Set what customers see on WhatsApp: the display name and its Meta review status, profile photo, category, description, address, email, and website.
- [Use Popcorn with the WhatsApp Business app](https://docs.trypopcorn.ai/channels/whatsapp-coexistence.md): Keep the WhatsApp Business app on the same number as Popcorn: set up coexistence, choose what happens when you reply from the app, and disconnect.
- [Products in WhatsApp](https://docs.trypopcorn.ai/channels/whatsapp-catalog.md): Connect a Meta catalog so your agent sends product cards in WhatsApp, turn on cart checkout, and read the catalog health card.
- [Set up Website chat](https://docs.trypopcorn.ai/channels/website-chat.md): Add Website chat to your website or store, set its name, messages and design, and show it on your storefront.
- [Add a WhatsApp button to your website](https://docs.trypopcorn.ai/channels/whatsapp-button.md): Set up the WhatsApp click-to-chat button for your website or store, customise its text and look, and install the embed code once.
- [Channel troubleshooting](https://docs.trypopcorn.ai/channels/troubleshooting.md): Fix WhatsApp connection, reconnect, display-name and delivery problems, a button or chat missing from your site, and a catalog that won't sync.
- [AI agents overview](https://docs.trypopcorn.ai/agents/overview.md): What an AI agent is in Popcorn, how to read the Agents page, what the default agent does, and how an agent picks up conversations.
- [Create an agent](https://docs.trypopcorn.ai/agents/create-an-agent.md): Create a new AI agent with New agent: name it, write or draft its instructions, switch on what it can do, then publish it for customers.
- [Writing agent instructions](https://docs.trypopcorn.ai/agents/writing-instructions.md): Write instructions that work with how Popcorn answers: knowledge base first, real tools instead of promises, clear scope, tone and language.
- [Agent capabilities](https://docs.trypopcorn.ai/agents/capabilities.md): What each agent switch does: hand over to your team, block spam, opt-outs, recommend products, take orders, track orders, follow-ups and more.
- [Check replies before sending](https://docs.trypopcorn.ai/agents/ai-manager.md): Score every reply before it is sent, retry replies below your target score, and hand over when the agent cannot do better (formerly AI Manager).
- [Connect knowledge, tools, channels and notifications](https://docs.trypopcorn.ai/agents/connect-knowledge-tools-channels.md): Give an agent knowledge bases and custom tools, attach WhatsApp numbers and the Website chat widget, and set where handover alerts go.
- [Test and publish an agent](https://docs.trypopcorn.ai/agents/test-and-publish.md): Try an agent in the test chat or on WhatsApp, publish a draft to new or open chats, and use version history to roll back.
- [Spotlight](https://docs.trypopcorn.ai/agents/spotlight.md): Read your agent's Performance score, the six quality areas, resolution and sentiment breakdowns, and the conversations to review.
- [Troubleshooting AI agents](https://docs.trypopcorn.ai/agents/troubleshooting.md): Fix an agent that does not reply, gives wrong answers, hands over too often or never, replies slowly, or ignores changes you made.
- [Knowledge overview](https://docs.trypopcorn.ai/knowledge/overview.md): How folders and articles give your agent its answers, what Draft and Published mean, and how to see which articles the agent uses.
- [Create folders and articles](https://docs.trypopcorn.ai/knowledge/writing-articles.md): Create folders, write or import articles, preview how the agent reads them, publish, and restore earlier versions.
- [Connect knowledge to an agent](https://docs.trypopcorn.ai/knowledge/connect-to-agents.md): Give an agent access to knowledge folders, publish the change, test it, and confirm which articles the agent actually uses.
- [Knowledge troubleshooting](https://docs.trypopcorn.ai/knowledge/troubleshooting.md): Fix an agent that ignores or misreads articles, outdated answers, failed imports, rejected folder names, and publishing problems.
- [Custom tools overview](https://docs.trypopcorn.ai/tools/overview.md): Let your agent call your own systems during a conversation, how a tool looks to the agent, and what your API must support.
- [Create a custom tool](https://docs.trypopcorn.ai/tools/create-a-tool.md): Build a tool with New tool: description, method, URL, headers, parameters and their sources, then connect it to an agent and test it.
- [Tools showcase](https://docs.trypopcorn.ai/tools/marketplace.md): Add a custom tool that another Popcorn account shared, or publish your own to the Tools showcase when it meets the sharing rules.
- [Inbox overview](https://docs.trypopcorn.ai/inbox/overview.md): How the Inbox is organised: folders, who is replying, what sends a conversation to Needs you, and the WhatsApp 24-hour reply window.
- [Work a conversation](https://docs.trypopcorn.ai/inbox/working-conversations.md): Take over from the agent, reply, send templates and products, add notes, snooze, close, block, read customer details, and use keyboard shortcuts.
- [Conversation tags and macros](https://docs.trypopcorn.ai/inbox/tags-and-macros.md): Create conversation tags with priorities, let the agent tag handovers, filter and sort by tag, and reuse replies with macros.
- [Popcorn mobile app](https://docs.trypopcorn.ai/inbox/mobile-app.md): Handle your Inbox from your phone: sign in, work conversations, start template chats, look up customers, and get push notifications.
- [Inbox troubleshooting](https://docs.trypopcorn.ai/inbox/troubleshooting.md): Fixes for replies that cannot be sent, the agent not replying, missing conversations, media the agent cannot handle, and notifications.
- [Customers](https://docs.trypopcorn.ai/customers/overview.md): Find every contact, edit details and tags, import or delete in bulk, and understand subscription and paused-campaign states.
- [Product catalog](https://docs.trypopcorn.ai/products/catalog.md): Manage the products your agent can recommend and sell: synced or manual, variants, custom options, and Boost, Normal or Hide.
- [Recommendation rules](https://docs.trypopcorn.ai/products/recommendation-rules.md): Tell your agent which products to show only, or show first, when a customer asks about a topic, season or occasion.
- [Orders](https://docs.trypopcorn.ai/orders/overview.md): Follow the orders your agent takes in conversations: statuses, payment methods, address collection, shipping, tracking and your store.
- [Campaigns overview](https://docs.trypopcorn.ai/campaigns/overview.md): How WhatsApp campaigns work in Popcorn: templates, Meta approval, credits, who gets messaged, working hours, and where to read results.
- [Templates](https://docs.trypopcorn.ai/campaigns/templates.md): Create a WhatsApp message template, add media, variables, buttons or a card carousel, submit it to Meta, and manage its status.
- [Send a campaign](https://docs.trypopcorn.ai/campaigns/send-a-campaign.md): Send a one-time WhatsApp campaign: pick a template, fill its variables, build the audience, check the estimate, send or schedule, read results.
- [Link buttons and tracking](https://docs.trypopcorn.ai/campaigns/link-buttons-and-tracking.md): Set up Open a link buttons with a fixed, personalised, or complete-link destination, and see how Popcorn tracks and reports clicks.
- [Automated campaigns](https://docs.trypopcorn.ai/campaigns/automated-campaigns.md): Send a WhatsApp template automatically when something happens in your Shopify, Salla or Zid store, such as an abandoned cart or a new order.
- [Delivery and reachability](https://docs.trypopcorn.ai/campaigns/delivery-and-reachability.md): What campaign message statuses mean, how WhatsApp daily limits affect sending, how retries work, and why Popcorn stops messaging some contacts.
- [Campaign troubleshooting](https://docs.trypopcorn.ai/campaigns/troubleshooting.md): Fix common campaign problems: rejected templates, campaigns that will not send, low delivery, repeated messages, wrong values, untracked links.
- [Home dashboard](https://docs.trypopcorn.ai/analytics/dashboard.md): Read Home: your agent's summary, the conversations that need you, and sales, orders, handover, message, agent and product figures for a date range.
- [Reports](https://docs.trypopcorn.ai/analytics/reports.md): Use Reports to measure conversation volume, first reply and resolution times, what your agent resolves alone, and team performance, and export CSVs.
- [Settings overview](https://docs.trypopcorn.ai/settings/overview.md): Find your way around Settings: personal, workspace, automation, commerce and developer pages, and who can see each one.
- [Profile, notifications and communication](https://docs.trypopcorn.ai/settings/profile-and-notifications.md): Update your name, business name and time zone, choose which inbox events alert you and how, set product-update preferences, and leave a workspace.
- [Workspace settings](https://docs.trypopcorn.ai/settings/workspace.md): Configure Settings → General: media handling, auto follow-up, working hours, default currency, product options, Zid VAT and the Knowledge workspace.
- [Team and roles](https://docs.trypopcorn.ai/settings/team-and-roles.md): Invite teammates, manage pending invites, change or remove members, work in several workspaces, and see what each role allows.
- [Shipping and payment](https://docs.trypopcorn.ai/settings/shipping-and-payment.md): Set the shipping options, delivery coverage and payment methods the AI agent uses when it creates an order for a customer in chat.
- [Plans and credits](https://docs.trypopcorn.ai/billing/plans-and-credits.md): Popcorn's plans, what a credit is, what uses credits, what happens when they run out, and how the Billing and usage page is laid out.
- [Credit usage](https://docs.trypopcorn.ai/billing/credit-usage.md): Track plan and extra credit balances, usage by source, each credit movement per conversation or campaign, and export the list as CSV.
- [Top-ups, plan changes and renewal](https://docs.trypopcorn.ai/billing/top-ups-and-renewal.md): Buy extra credits, turn on automatic top-up, renew early, change your plan, pay invoices and fix payment problems on the Billing page.
- [AI assistants overview](https://docs.trypopcorn.ai/ai-assistants/overview.md): Connect ChatGPT, Claude or Codex to your Popcorn workspace so it can run campaigns, work the inbox and answer questions about your store.
- [Connect ChatGPT](https://docs.trypopcorn.ai/ai-assistants/connect-chatgpt.md): Add Popcorn to ChatGPT with a server URL or from ChatGPT's directory, approve access in your browser, and try your first requests.
- [Connect Claude](https://docs.trypopcorn.ai/ai-assistants/connect-claude.md): Add Popcorn to Claude on the web, desktop and mobile as a custom connector, or to Claude Code with one command, then approve access and try it.
- [Connect Codex](https://docs.trypopcorn.ai/ai-assistants/connect-codex.md): Add Popcorn to Codex CLI with two commands, sign in through your browser, and try your first requests.
- [Permissions and safety](https://docs.trypopcorn.ai/ai-assistants/permissions-and-safety.md): How an assistant's access to your workspace is granted, limited by your role, confirmed before risky actions, and revoked.
- [What you can do](https://docs.trypopcorn.ai/ai-assistants/what-you-can-do.md): Example requests for a connected assistant in every area of Popcorn, the built-in workflows it can run, and what it cannot do.
- [Changelog](https://docs.trypopcorn.ai/changelog.md): See what's new in Popcorn AI
- [API Reference](https://docs.trypopcorn.ai/api-reference/introduction.md): Create an API key, authenticate requests to the Popcorn API, and find the endpoints for sending templates and receiving delivery status.
- [Send a Template](https://docs.trypopcorn.ai/api-reference/templates/send.md): Send an approved WhatsApp template to one phone number from your own system, list your templates, and handle the responses and errors.
- [Message Status Webhooks](https://docs.trypopcorn.ai/api-reference/webhooks/message-status.md): Configure a webhook URL and token, choose which delivery events to receive, and read the payload Popcorn sends for sent, delivered, read, and failed.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.