# NextIntent

- [Welcome to NextIntent](https://docs.nextintent.ai/index.md): NextIntent for Shopify notices the moment a shopper gets stuck in your store and says one true sentence from your own facts, once. Everyone else is left alone.
- [Install the app](https://docs.nextintent.ai/getting-started/install.md): Install NextIntent from the Shopify App Store, turn on one app embed in your theme, and pick a mode. About two minutes, no code.
- [What it reads from your store](https://docs.nextintent.ai/getting-started/what-it-reads.md): The facts sheet: the shipping lines, return window, discount codes, product prices and product notes NextIntent reads from Shopify, where each one comes from, and how to change it.
- [The app embed](https://docs.nextintent.ai/getting-started/app-embed.md): The one theme switch that puts NextIntent on your storefront: what it loads, what it costs the page, and how to turn it on or off.
- [Verify it is live](https://docs.nextintent.ai/getting-started/verify.md): How to confirm NextIntent is reading your storefront, what the Home page shows at each stage, and what to check when it says Off.
- [Watch mode and active mode](https://docs.nextintent.ai/getting-started/modes.md): The two modes NextIntent runs in: watch mode records what it would have said and shows nothing, active mode shows the sentence to stuck shoppers and is billed. How to switch, and what changes.
- [FAQ](https://docs.nextintent.ai/faq.md): Short answers to the questions store owners ask before and after installing NextIntent for Shopify.
- [The moment](https://docs.nextintent.ai/how-it-works/the-moment.md): What NextIntent means by a stuck shopper: the signals it reads, the idle rule, the situations it recognises, and the ones it deliberately leaves alone.
- [What it says](https://docs.nextintent.ai/how-it-works/what-it-says.md): How NextIntent composes the one sentence a stuck shopper sees, the rules every sentence has to pass, and why silence is the default.
- [What shoppers see](https://docs.nextintent.ai/how-it-works/what-shoppers-see.md): The card: how it looks on the page, when it appears, how the shopper dismisses it, when it is withdrawn before it is shown, and what it never contains.
- [Watch mode](https://docs.nextintent.ai/how-it-works/watch-mode.md): What NextIntent records while Messages are off, how to read it, and how to use a week of watch mode to decide whether to turn active mode on.
- [Held back to compare](https://docs.nextintent.ai/how-it-works/held-back.md): Why NextIntent leaves a random share of stuck shoppers alone, how the share is chosen, the 20% ramp on new stores, and how the comparison is shown on Money.
- [Quiet after purchase](https://docs.nextintent.ai/how-it-works/quiet-after-purchase.md): A shopper who just paid hears nothing from NextIntent for 24 hours: how the app knows about the order, what it withdraws, and why.
- [What "spoke to" means](https://docs.nextintent.ai/how-it-works/spoke-to.md): The one definition every number in NextIntent rests on: a shopper was spoken to only if a sentence was actually shown on their screen. How that is confirmed, and what it rules out.
- [Settings overview](https://docs.nextintent.ai/settings/overview.md): A map of the NextIntent Settings page: the six sections, what each one controls, and which pages explain them in full.
- [Switches](https://docs.nextintent.ai/settings/switches.md): The three switches under What NextIntent may do: the app embed, Messages, and the On-page card. What each one does, what changes when it is off, and what it costs.
- [What it may say](https://docs.nextintent.ai/settings/what-it-may-say.md): The four choices saved on your store: how to speak on the page, whether a card may mention an offer, your delivery promise, and the path to your size guide.
- [Discount codes](https://docs.nextintent.ai/settings/discount-codes.md): How NextIntent handles discount codes: what it notices when a code is declined, when it may name one of your codes, why offers are off by default, and what it costs you either way.
- [Product notes](https://docs.nextintent.ai/settings/product-notes.md): The one line you write on a product that NextIntent can say to a shopper who cannot decide on a size or an option: where the field is, what to write, and why nothing is said without one.
- [Held back share](https://docs.nextintent.ai/settings/held-back-share.md): The setting that decides what share of stuck shoppers NextIntent leaves alone for the comparison on Money: the three choices, the ramp on new stores, and how to pick.
- [Reports](https://docs.nextintent.ai/settings/reports.md): The weekly or daily brief NextIntent sends by email or to Slack: how to set it up, what it contains, and how to preview or send one now.
- [Money](https://docs.nextintent.ai/reports/money.md): The Money page: shoppers spoken to, orders credited, revenue from those shoppers, sold at full price, stalled carts right now, where carts are lost, the ledger, and the comparison with shoppers left alone.
- [Moments](https://docs.nextintent.ai/reports/moments.md): The Moments page and the moment detail: every stuck shopper, what the app did, the sentence, and what happened next, with the filters We spoke, We waited, We stayed quiet.
- [Reasons](https://docs.nextintent.ai/reports/reasons.md): The Reasons page: why shoppers stall in your store, grouped, with how many were spoken to and what happened next, and the moments behind each group.
- [The brief](https://docs.nextintent.ai/reports/brief.md): The weekly or daily note NextIntent sends: the three numbers, the restraint line, the top reasons, the one sentence that worked, and the cap line when it matters.
- [Exports](https://docs.nextintent.ai/reports/exports.md): Download the ledger and the moments as CSV from Settings → Your data: the columns in each file, what they mean, and what to do with them.
- [Pricing](https://docs.nextintent.ai/billing/pricing.md): Watch mode is free. Active mode costs 5% of orders from shoppers NextIntent spoke to, when the order comes within seven days of the moment, under a monthly cap you approve in Shopify. Nothing else.
- [The cap](https://docs.nextintent.ai/billing/the-cap.md): The monthly cap you approve in Shopify: what it is, how to change it, the warning at 80%, and what the app does when the month's charges reach it.
- [Pause and resume](https://docs.nextintent.ai/billing/pause-and-resume.md): What happens when the cap pauses active mode, what the pause message tells you, the two ways a pause lifts, and why Turn on is refused while paused.
- [See your charges](https://docs.nextintent.ai/billing/see-your-charges.md): Where NextIntent's charges appear in Shopify, how to match each one to a credited order, when the meter runs, and how to approve the plan or add a payment method.
- [Refunds and currency](https://docs.nextintent.ai/billing/refunds-and-currency.md): How a refund changes a credited order, how orders in a currency other than US dollars are billed, and what is skipped rather than guessed.
- [Privacy and data](https://docs.nextintent.ai/privacy-and-data.md): What NextIntent reads from your storefront and your orders, what it keeps, what it never keeps, how a shopper's data is erased, and what to tell a customer who asks.
- [Try it on your own store](https://docs.nextintent.ai/test-it.md): The Try it page: ten scenarios you walk through as a shopper on your own store, what should happen in each, and what each one proves.
- [Troubleshooting](https://docs.nextintent.ai/troubleshooting.md): The common questions from the app's own pages: why the card did not show, why a shopper was held back, why a credited order looks wrong, why the sheet says not set, and what to check first.
- [Developer overview](https://docs.nextintent.ai/developers/overview.md): The pieces of NextIntent for any website: the storefront SDK, the realtime collector, the decision engine, and card delivery, and what a site needs to run it.
- [Install the SDK](https://docs.nextintent.ai/developers/install-sdk.md): Put NextIntent on any website: the script tag, allowed origins, the settings call, the visitor frame, and how to confirm signals are arriving.
- [The card and the event](https://docs.nextintent.ai/developers/the-card.md): How a sentence reaches the page: the card route, the poll, the ack, the nextintent:moment event for your own rendering, and the popup-tool hooks.
- [The facts sheet](https://docs.nextintent.ai/developers/facts-sheet.md): Every field of a site's facts sheet, its limits and how the engine uses it, and the replace semantics of PATCH /v1/sdk/{id}/facts.
- [Commerce endpoints](https://docs.nextintent.ai/developers/commerce-endpoints.md): The cart beacon, the order and refund feeds, the checkout steps and the erasure endpoint on sdk.nextintent.ai: what each takes, how it is authenticated, and what the engine does with it.
- [Data and privacy for developers](https://docs.nextintent.ai/developers/data-and-privacy.md): Hash-and-drop on the page, what the collector logs, what the engine records, retention, and how erasure propagates through the platform.
- [API overview](https://docs.nextintent.ai/api-reference/overview.md): The NextIntent management API at api.nextintent.ai/v1: websites, switches, the facts sheet, the views, and API keys, per account.
- [Authentication](https://docs.nextintent.ai/api-reference/authentication.md): Authenticate with an API key (ni_live_...) or a console session as a Bearer token. Keys are account-wide or bound to one website, carry scopes, and are minted only by a person.
- [List websites](https://docs.nextintent.ai/api-reference/sites/list.md): List every website the caller can see. A site-bound key sees only its own website.
- [Create a website](https://docs.nextintent.ai/api-reference/sites/create.md): Create a website with a name and its allowed origins. Account-wide keys with sites:write only.
- [Read a website](https://docs.nextintent.ai/api-reference/sites/retrieve.md): Read one website with its switches and state.
- [Update a website](https://docs.nextintent.ai/api-reference/sites/update.md): Change a website's name, switches, held-back share, vertical or allowed origins.
- [Delete a website](https://docs.nextintent.ai/api-reference/sites/delete.md): Delete a website. Account-wide keys only.
- [Read the facts sheet](https://docs.nextintent.ai/api-reference/facts/retrieve.md): Read what this website is willing to have said on its behalf.
- [Replace the facts sheet](https://docs.nextintent.ai/api-reference/facts/update.md): Replace the whole facts sheet. Send every field you want kept.
- [The store view](https://docs.nextintent.ai/api-reference/views/store.md): Recovered revenue, discounts not given away, stalled carts right now, the ledger, where carts are lost, and the held-back comparison.
- [Reasons](https://docs.nextintent.ai/api-reference/views/reasons.md): Why shoppers stall, grouped, with what happened next.
- [Moments](https://docs.nextintent.ai/api-reference/views/moments.md): Moments newest first, with limit, before and verdict.
- [List API keys](https://docs.nextintent.ai/api-reference/keys/list.md): List the account's keys. Console session only.
- [Create an API key](https://docs.nextintent.ai/api-reference/keys/create.md): Mint a key. The token is returned once. Console session only.
- [Revoke an API key](https://docs.nextintent.ai/api-reference/keys/revoke.md): Revoke a key. Console session only.

## OpenAPI Specs

- [openapi](/openapi.json)