> For the complete documentation index, see [llms.txt](https://docs.peakcommerce.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.peakcommerce.com/whats-new.md).

# What's New

The latest features, improvements, and fixes in PeakCommerce. Admins also see new entries in the notification bell at the top of the app.

### Stripe subscriptions stay in step with Stripe

**New** · September 29, 2026

When Stripe renews, changes or ends a subscription, PeakCommerce now updates its own copy — status, current period, billing interval and cancel-at-period-end — and sends your webhooks the matching subscription and payment events. Connect it once per Stripe integration with a webhook endpoint and its signing secret.

[Learn more →](https://docs.peakcommerce.com/integrations/stripe/stripe-subscription-sync)

***

### Stripe API cancellations now honor the paid period

**Improved** · September 29, 2026

Cancelling a Stripe-billed subscription through the API now asks Stripe to end it at the close of the current paid period, the same as a cancel from the customer portal. The subscription stays active until then, and subscription.cancelled is sent when it ends.

[Learn more →](https://docs.peakcommerce.com/developers/api-reference/subscriptions)

***

### Webhook connections now require HTTPS

**Improved** · September 29, 2026

Webhook endpoint URLs must use https\:// when you add or edit a subscription, and loopback or private network addresses are refused with the reason shown. A new Security and data protection page summarizes how PeakCommerce protects your data and the systems you connect.

[Learn more →](https://docs.peakcommerce.com/product/using-peakcommerce/authentication-and-security/security-and-data-protection)

***

### Update an API key's scopes without replacing it

**Improved** · September 29, 2026

The admin API can now update an existing key's scopes in place, so an integration keeps its key while its access is widened or narrowed.

[Learn more →](https://docs.peakcommerce.com/developers/api-reference/admin-api-keys)

***

### Unknown amounts show as a dash, not $0

**Fixed** · September 29, 2026

Where an order's subtotal, recurring total or amount due today, or an account's net MRR, isn't known yet, PeakCommerce now shows — instead of a misleading $0.00.

***

### Jump through Audit Logs with numbered pages

**Improved** · September 29, 2026

Audit Logs now pages through long histories with numbered pages, so you can jump straight to the part of the record you need.

[Learn more →](https://docs.peakcommerce.com/product/using-peakcommerce/authentication-and-security/viewing-audit-logs)

***

### Book a product set line as its own order action

**New** · September 15, 2026

Mark any product set line as "Its own order line" and turn on Honor order grouping in a journey's create-order step: checkout still places one order and one subscription, but each marked line is booked as its own order action — easier to read line by line, and recorded on the day that line actually starts. Invoicing is unchanged.

[Learn more →](https://docs.peakcommerce.com/guides/feature-guides/billing-setup/guide-booking-a-line-as-its-own-order-action)

***

### Contacts, now in the API

**New** · September 6, 2026

The people behind an account are readable from your own systems: list a tenant's contacts, filter to an exact email address, or fetch one by id. It uses the same scoped keys as the rest of the v1 surface, so a key with read scope is all an integration needs.

[Learn more →](https://docs.peakcommerce.com/developers/api-reference/contacts)

***

### Consent, set once for the whole journey

**New** · September 4, 2026

Which acknowledgement a buyer must give — and where it appears — is now a property of the journey rather than something wired step by step. Every route through the journey is checked when you publish, so one can't go live with a path that skips consent, and each acceptance is recorded against the session that produced it.

[Learn more →](https://docs.peakcommerce.com/product/settings/company-settings/acknowledgements-overview)

***

### Collapse the Settings sidebar too

**Improved** · September 3, 2026

Settings now collapses its sidebar the same way the main navigation does, and both stay the way you left them between visits — more room for the page you came to work on.

***

### Find a session by the customer, not the session id

**New** · September 1, 2026

A support call starts with a name or an email address. Journey sessions can now be searched by customer email, customer name, or date and time, so you can open the exact session someone is asking about instead of scrolling a list.

[Learn more →](https://docs.peakcommerce.com/product/reporting-and-analytics/analytics-workspace/session-explorer)

***

### New guides: the rules engines, and working with Mango

**Improved** · September 1, 2026

Seven walkthroughs — policies, plan dependencies, audiences, retention routing, segment and partner pricing, change-lifecycle timing, and promotions — each with a short video of the thing being built. Alongside them, a full guide to Mango: what she can see, how the propose-and-approve build flow works, and when to hand off to a human.

[Learn more →](https://docs.peakcommerce.com/product/rules-and-customizations/rules-overview)

***

### The recurring total says what the invoice will say

**Improved** · August 30, 2026

When a subscription carries more than one discount, the figure on the card rarely matches the percentages added up in your head — and it isn't meant to. The recurring total reads the amounts your billing system says it will charge rather than presenting them as an estimate, and a new article walks through the cases that surprise people.

[Learn more →](https://docs.peakcommerce.com/product/customer-success-portal/discounts-and-the-recurring-total)

***

### Market Studio — one place to run every currency you sell in

**New** · August 26, 2026

A market is a currency: the market a visitor resolves to decides the payment page they see, the language they read, and the profile they get. Market Studio is where you set that up — which journeys and portals belong to a market, which hosted payment page serves each of them, and what else that market's buyers receive — with a trace view that replays how a given customer was routed.

[Learn more →](https://docs.peakcommerce.com/product/using-peakcommerce/market-studio)

***

### Session event exports carry the payload

**Improved** · August 26, 2026

Exporting a journey session's events to CSV now includes the detail each event carried, not just its name and timestamp — enough to reconstruct what happened without opening the session.

***

### One Support menu, every route to help

**Improved** · August 24, 2026

Support is now a single entry that opens one dialog — ask Mango, search the help center, or reach a person — instead of separate launchers competing for the corner of the screen.

[Learn more →](https://docs.peakcommerce.com/support/getting-help-from-mango)

***

### Say what each plan actually grants

**New** · August 23, 2026

Define your capabilities once as a feature vocabulary, then grant them per plan — as a plain include, as a value your application reads (a seat limit, a tier string), or as unlimited. Your code gates on the feature key rather than the plan name, so changing which plan includes something takes effect without a release, and entitlements reach your app through the API and webhooks.

[Learn more →](https://docs.peakcommerce.com/product/settings/billing-catalog/plan-entitlements)

***

### Slack workspaces, under an administrator's control

**New** · August 19, 2026

Connect Slack workspaces, map Slack users to PeakCommerce accounts, and choose which slash commands your reps can run — from one settings page, gated by the Integrations permission. Bot credentials and per-user mappings live in the product rather than scattered across environment files.

[Learn more →](https://docs.peakcommerce.com/product/settings/developer-tools/slack)

***

### Journey version history, side by side

**Improved** · August 17, 2026

Published versions now sit in a master/detail view: pick a snapshot on the left, read what changed on the right — instead of the detail landing at the bottom of the page.

[Learn more →](https://docs.peakcommerce.com/product/journeys-and-pages/journey-basics/journey-history)

***

### Compare every profile at a glance

**New** · August 13, 2026

The Permissions Grid puts profiles across the top and permissions down the side, so "how do these two differ?" is one screen instead of opening each profile in turn — sidebar sections, resource access levels, and named capabilities, with the differences flagged.

[Learn more →](https://docs.peakcommerce.com/product/using-peakcommerce/profiles-and-permissions/comparing-profiles)

***

### Mango is honest about being away

**Improved** · August 12, 2026

On the rare occasion the assistant can't hold a conversation, the Mango bubble now shows a clear offline state — with direct routes to the help center and support — instead of a launcher that looks alive. It restores itself automatically the moment service returns, no reload needed.

[Learn more →](https://docs.peakcommerce.com/product/getting-started/meet-mango)

***

### Mango builds native, on-brand components

**New** · August 11, 2026

Describe a component and Mango now assembles it from the same blocks the page editor uses — styled by your brand tokens automatically, every element individually selectable and editable afterwards, no code involved. Live data renders through the familiar placeholder syntax with proper currency, number, and date formatting, and a layout that couldn't render is refused at save with the exact problem named — a component can't be published quietly broken.

[Learn more →](https://docs.peakcommerce.com/developers/native-components)

***

### Save any part of a page as a component

**New** · August 11, 2026

Arranged something on a page you'd like to reuse? Select its top block and choose Save as component: pick which text values become editable fields, and it lands in your Component Library ready to drop anywhere. It's also the fastest way to work with Mango — ask for something close, adjust it by hand on the page, keep the result.

[Learn more →](https://docs.peakcommerce.com/developers/native-components)

***

### A portal built for sales teams

**New** · August 10, 2026

Sales is now a full role with its own portal, separate from customer support: its own accounts list and account workspace with the same depth support staff have, team-only notes that stay inside the sales team, and its own set of pages you can tailor in the page editor — the editor now treats Sales as a portal type with its own component library. Grant it like any other role, from a user's role and profile.

[Learn more →](https://docs.peakcommerce.com/product/sales-portal/sales-portal-overview)

***

### Journeys and Pages, now in the API

**New** · August 10, 2026

Journeys are a first-class part of the v1 API for the first time: list, create, update, and delete journeys, manage steps and commerce actions, read and restore versions, and publish. Pages gained publish, version history, and restore. Publishing anywhere is an explicit, separately-permissioned action that runs the same validation gates as the app's own publish button — nothing goes live over the API by accident.

[Learn more →](https://docs.peakcommerce.com/developers/api-reference/admin-content)

***

### API keys with exactly the authority you intend

**Improved** · August 9, 2026

API keys can now carry narrow, per-resource scopes — a key can hold exactly journeys:write or pages:read instead of whole-tenant access. Publishing is its own permission, so a key that authors drafts can never push them live. Existing read, commerce, and admin keys keep working unchanged; narrow keys are minted through the v1 admin API.

[Learn more →](https://docs.peakcommerce.com/developers/api-reference/authentication)

***

### Sell one-time products — and price recurring ones properly

**New** · August 4, 2026

The catalog now handles more than subscriptions: create a One-Time Purchase product with its own price, imagery, and storefront details, alongside Recurring plans and Bundles. Recurring products get a real pricing-model picker — Flat Fee, Per Unit, Volume, or Tiered — with a band editor and a live calculator showing what any quantity costs. And every product now has a fuller page: a live preview of the exact card customers see, full tier bands in the pricing table, and which Product Sets carry it.

[Learn more →](https://docs.peakcommerce.com/product/using-peakcommerce/products-and-bundles/products-overview)

***

### Quotes: build, send, and close a deal in one place

**New** · August 3, 2026

Build a priced proposal from your catalog, send the customer a secure link they can approve without creating an account, and turn the accepted quote into a real order. One click reprices linked lines from the catalog while keeping your discount, and a discount past your authority ceiling holds the quote for a second person's sign-off — a genuine two-person rule. Every quote carries a status from draft to completed, so you always know where the deal stands.

[Learn more →](https://docs.peakcommerce.com/product/sales-portal/quotes-overview)

***

### Learn PeakCommerce by watching

**New** · August 1, 2026

The help center now has a full video library: short product guides filmed in the real app — journeys, commerce actions, pricing and retention rules, offers, fraud signals, usage-based billing, and more — plus the Quote-to-Cash Playbook and Market Trends series. Videos are embedded right on the doc pages they explain, and the library page collects them all in one place.

[Learn more →](https://docs.peakcommerce.com/guides/video-library)

***

### Know which plan is running — and which one's next

**Improved** · July 31, 2026

A plan queued to start later — a paid plan waiting behind a free trial, say — now reads “Starts {date}” instead of being badged as current, in the customer portal and the agent console alike. The order summary shows the active plan and the scheduled one separately, and editing a queued plan swaps what's scheduled while keeping its start date, with nothing due today. Admins can also flag genuine trial plans in the catalog so trial-only offers reach exactly the right customers.

[Learn more →](https://docs.peakcommerce.com/product/customer-self-service/subscription-management/customer-subscription-management)

***

### Finer control over who can un-cancel

**Improved** · July 31, 2026

Revoking a scheduled cancellation now has its own permission on customer, agent, and sales profiles — no longer tied to the Cancel Plan grant — with three levels: no access, view (see the scheduled-cancellation banner and why revoking is blocked), or manage (the one-click Revoke button). It starts at no access, so grant it deliberately alongside the retention-journey setting.

[Learn more →](https://docs.peakcommerce.com/product/using-peakcommerce/profiles-and-permissions/portal-action-permissions)

***

### Changed their mind? Un-cancel a scheduled cancellation

**New** · July 24, 2026

Subscriptions cancelled for a future date now show exactly when access ends — “Scheduled for {date}” right under the status badge — and, when you enable it on your retention journey, the customer (or your agent) can revoke the cancellation in one click before that date arrives. A built-in safeguard requires all invoices to be paid first.

[Learn more →](https://docs.peakcommerce.com/product/customer-self-service/subscription-management/customer-subscription-management)

***

### See — and create — sub-accounts from the account workspace

**New** · July 24, 2026

A new Subaccounts tab on the agent's account view lists an account's children straight from your billing system's own hierarchy, and a configurable journey lets agents create a new sub-account with the parent linked automatically. Built for the parent-child account structures B2B billing runs on.

[Learn more →](https://docs.peakcommerce.com/product/customer-success-portal/working-with-an-account)

***

### Concessions, governed

**New** · July 23, 2026

Give reps real discount authority without giving away the store: admins define concession bands — value ranges tied to a reason vocabulary and the right GL bucket — with a hard ceiling per journey. Reps compose the concession right inside the change-plan flow, the server enforces the ceiling no matter what, and every grant is recorded and forwarded to your CRM and ERP through journey context.

[Learn more →](https://docs.peakcommerce.com/guides/feature-guides/retain-and-manage/guide-csr-assisted-change-plan)

***

### Agents can add a customer's payment method — safely

**Improved** · July 23, 2026

The account workspace's payment-methods panel now adds a card through your billing system's secure hosted payment page, in a modal, so reps can help a customer over the phone without card data ever touching PeakCommerce. Admins choose which hosted page each surface uses.

[Learn more →](https://docs.peakcommerce.com/product/customer-success-portal/working-with-an-account)

***

### Your brand, down to the browser tab

**Improved** · July 23, 2026

Upload your favicon directly in Company Profile — no hosting required — and your signed-in customer and partner portals pick it up automatically. Uploads are validated for safety, and a hosted URL still works for your public pages.

[Learn more →](https://docs.peakcommerce.com/product/settings/company-settings)

***

### A full account Timeline for your support team

**New** · July 21, 2026

Every account now has a single chronological history: lifecycle stages, plan and product changes, billing events synced nightly from your billing system, retention outcomes, and staff notes — searchable and filterable in one feed. Notes log straight to your CRM as activity history, and escalations stand out without triggering CRM case workflows.

[Learn more →](https://docs.peakcommerce.com/product/customer-success-portal/account-timeline)

***

### On-brand pages by default

**Improved** · July 21, 2026

Text and heading blocks gain a brand-palette color control, section backgrounds are picked from the same curated palette, and the built-in marketing blocks — pricing tables, feature grids, testimonials — now follow your brand colors automatically and reflow cleanly on tablets and phones.

[Learn more →](https://docs.peakcommerce.com/product/journeys-and-pages/pages)

***

### Manage your users' sign-in lifecycle without leaving PeakCommerce

**Improved** · July 20, 2026

The user detail page now handles the full authentication toolkit: reset a password, send a verification email, change a user's email or phone, block or unblock sign-in, and reset MFA enrollment — each action audited, no identity-provider console required.

[Learn more →](https://docs.peakcommerce.com/product/using-peakcommerce/users-and-user-roles/editing-a-user)

***

### A cleaner, tabbed editor for journey steps

**Improved** · July 16, 2026

Editing a journey step now opens a focused full-page editor — a left rail groups everything into Overview, Variables, Custom fields, Advanced, and Tracking scripts, so there's no more long scroll. The role picker is searchable, unsaved-edit dots show what changed, and one Save saves the whole step, tracking scripts included.

[Learn more →](https://docs.peakcommerce.com/product/journeys-and-pages/journey-steps/managing-journey-steps)

***

### Usage-based billing with Metronome, now native

**New** · July 15, 2026

Metronome joins Zuora and Stripe as a native billing provider. Connect it under Settings → Integrations and sell metered, consumption-priced products through the same catalog, journeys, and customer portal you already use — Metronome rates the usage and finalizes invoices, and a linked Stripe integration collects payment automatically.

The full lifecycle runs natively: catalog sync flattens Metronome products and rate cards into your PeakCommerce catalog (monthly and annual rates become distinct plans), signup journeys provision the customer and contract with included allowances and overage rates, card capture happens right in the payment step, and plan changes, retention discounts, and cancellations all write back to the contract. Optional usage ingest streams executed commerce value to Metronome as it happens.

[Learn more →](https://docs.peakcommerce.com/integrations/metronome/metronome-usage-based-billing)

***

### Customers see live usage against their plan allowance

**New** · July 15, 2026

On usage-based plans, the customer portal now shows a live usage drawdown — real consumption against the included allowance, a clear flag when usage crosses into overage, and how many days remain in the billing period. No more surprise invoices.

***

### Install your analytics and tag-manager scripts, no engineering required

**New** · July 15, 2026

Add Google Tag Manager, GA4, VWO, Heap, or any analytics snippet to your public storefront, signup, and payment pages straight from Settings — and layer page-, journey-, or even step-level snippets on top, so every step of a multi-step funnel can fire its own goal. Behind-login tracking in the customer portal stays off until you deliberately opt in.

[Learn more →](https://docs.peakcommerce.com/product/settings/developer-tools/tracking-scripts)

***

### Offers get a dedicated page and a full-page editor

**New** · July 14, 2026

Every offer now has its own page — plain-English terms, redemption stats, guardrails, and the exact catalog discount it resolves to — plus a full-page editor with a live customer preview and billing-impact estimate that update as you type.

[Learn more →](https://docs.peakcommerce.com/product/using-peakcommerce/products-and-bundles/offers-and-discounts)

***

### Retention discounts with built-in guardrails

**Improved** · July 13, 2026

Save offers in cancellation flows now apply through governed offer records with per-customer usage caps and a live conflict check against your billing system — a discount can never stack twice, and an offer only reappears once an existing discount is about to end.

Each offer controls its own guardrails: a per-customer redemption cap counted over the customer's lifetime or a rolling window, a **conflict scope** that decides which existing discounts suppress the offer, and a **re-offer window** that lets the offer resurface just before a blocking discount expires. Checks run against live billing state at the moment of acceptance. And a discount accepted during a free trial now automatically waits and activates when the paid subscription begins — the customer is told exactly when it starts.

[Learn more →](https://docs.peakcommerce.com/product/using-peakcommerce/products-and-bundles/offers-and-discounts)

***

### Design your signup form, field by field

**New** · July 12, 2026

The signup step now has a visual field editor: drag fields onto a live preview, reorder them, and set each field's format, requirement, width, label, and error message. Add address or job-title presets — or fully custom fields — and the preview validates exactly like the real form.

[Learn more →](https://docs.peakcommerce.com/product/journeys-and-pages/journey-steps/signup-form-fields)

***

### See exactly what changed — and restore any journey version

**Improved** · July 11, 2026

Journey version history now summarizes what changed in every version and shows a color-coded diff against the previous one. Restore any past version into a new draft with one click — what's live stays untouched until you publish.

[Learn more →](https://docs.peakcommerce.com/product/journeys-and-pages/journey-basics/journey-history)

***

### Test commerce actions before you publish

**New** · July 10, 2026

Every commerce action now has a Test panel: supply sample data and instantly see the resolved payload, with invalid values caught against your CRM's restricted picklists — no live order required. And when a blocking action does fail, steps can route visitors to a fallback page instead of stopping them.

[Learn more →](https://docs.peakcommerce.com/product/journeys-and-pages/journey-steps/commerce-actions)

***

### Saved payment methods, managed in a click

**Improved** · July 10, 2026

Customers can set a new default or remove a saved payment method straight from the payment-methods list in the customer portal, with a confirmation before anything is removed.

***

### Reliable invoice PDF downloads

**Fixed** · July 10, 2026

Downloading an invoice from the customer portal now returns a proper PDF every time — with a clear message in the rare case a document is still being generated by the billing system.

***

### Ask Mango, right inside the app

**New** · July 9, 2026

Mango is now one click away anywhere in the admin app. Ask about your catalog, plans, journeys, live journey activity, or your retention numbers — by chat or voice — and Mango answers from your own workspace. It reads, it never changes anything.

[Learn more →](https://docs.peakcommerce.com/product/getting-started/meet-mango)

***

### Find any account from the header search

**New** · July 7, 2026

The global search now finds customer accounts by name, account number, or CRM id and jumps straight to the account workspace. Results respect each user's role and account scope — people only ever see what they're allowed to.

***

### A sharper accounts workspace for support teams

**Improved** · July 6, 2026

The accounts list gets a cleaner search-and-filter toolbar, sortable Net MRR and CRM-id columns, and at-a-glance tiles that mix live counts — active accounts, customers in a retention flow — with nightly usage and trial-ending signals.

***

### A clearer plan-change summary — for customers and CSRs

**Improved** · July 6, 2026

Changing a plan now shows a live order summary: what you have today, what you'll have after the change, per-line price differences, and the exact prorated amount due today. Customers see it in the portal; CSRs see the same summary plus a redesigned billing preview before they confirm.

***

### Faster, more reliable billing operations

**Improved** · July 5, 2026

Subscription changes — plan switches, add-ons, quantity updates, pauses, and cancellations — now flow through your billing system's modern orders API, giving more consistent results and more accurate cost previews for every change.

***

### Show trial-only plans to the right customers

**New** · July 4, 2026

Product-set items can now be marked “Only during an active trial,” so trial-specific plans appear for trialing customers and stay hidden from paying ones — while a customer's current plan always remains visible.

***

### Meet Mango, your AI assistant

**New** · June 28, 2026

Our AI assistant now has a name and a face. Look for “Create with Mango” in the page and component editors and on the rule engines — describe what you want and Mango drafts it for you to review.

Mango is the clever mongoose who lives inside PeakCommerce and helps you build. Build components and pages from a description, draft rules on the automation engines, and ask Mango questions from the help docs. Every change Mango proposes is yours to **accept, reject, or refine** — a human is always in the loop.

[Learn more →](https://docs.peakcommerce.com/product/getting-started/meet-mango)

***

### A redesigned admin Dashboard

**New** · June 27, 2026

The admin home is now a command center — the metrics, recent activity, and quick actions you reach for most, surfaced the moment you sign in. Panels you have no data for stay hidden, so the view stays relevant.

[Learn more →](https://docs.peakcommerce.com/product/reporting-and-analytics/dashboard)

***

### Outbound integration usage at a glance

**New** · June 24, 2026

API Usage now shows aggregated outbound rate gauges for your integrations, so you can see how close each one is to its limits before it becomes a problem.

***

### Separate Change-Plan and Cancel-Plan permissions

**Improved** · June 20, 2026

Subscription management splits into two distinct permissions — Change Plan and Cancel Plan — so you can let a CSR adjust a subscription without granting the ability to cancel it.

***

### Reliable journey version history

**Fixed** · June 18, 2026

Editing a journey now records a draft snapshot every time, so version history is complete and you can compare or roll back with confidence. An “unpublished changes” indicator shows when a draft differs from what’s live.

***

### Serve portals and pages on your own domain

**New** · June 14, 2026

Map your own custom domains and subdomains to your customer portal, partner portal, and hosted pages, so customers see your brand end to end. Add a hostname, point your DNS at the records we give you, and PeakCommerce provisions the certificate for you.

***

### A clearer Settings area

**Improved** · June 9, 2026

Settings now opens to a home hub with quick actions and grouped sections, and you reach it from your user menu in the bottom-left corner. Users, Profiles, API Keys, integrations, and the rest are organized so you can find what you need faster.

***

### See what a profile grants — and who has it

**Improved** · June 3, 2026

Permission profiles now show their full permission set at a glance and list every user assigned to them, so you can audit access without guesswork. View a profile read-only, or edit it in place.

***

### Sell plans programmatically with the Agent API

**New** · May 27, 2026

The PeakCommerce Agent API (v1) lets your own systems — and AI agents — discover plans, build carts, preview pricing, and place orders, with your pricing and discount policies enforced on the server. Explore it in the developer docs.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.peakcommerce.com/whats-new.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
