# HeyCrust documentation

Public guides for the current product. Read the credential, source and side-effect requirements before acting.

- [Getting started](https://heycrust.com/docs/getting-started): Choose a path through HeyCrust and verify the data you connect. — [Markdown](https://heycrust.com/docs/markdown/getting-started)
- [For app owners](https://heycrust.com/docs/app-owners): Connect apps, understand your data, automate carefully and manage partners. — [Markdown](https://heycrust.com/docs/markdown/app-owners)
- [For affiliates](https://heycrust.com/docs/affiliates): Join programs, refer merchants and follow earnings and manual payments. — [Markdown](https://heycrust.com/docs/markdown/affiliates)
- [For developers](https://heycrust.com/docs/developers): Integrate with the actual HeyCrust credentials, app identity and event contracts. — [Markdown](https://heycrust.com/docs/markdown/developers)
- [API reference](https://heycrust.com/docs/api): Public HTTP contracts, credentials, app scopes and exact financial values. — [Markdown](https://heycrust.com/docs/markdown/api)
- [MCP](https://heycrust.com/docs/mcp): Use HeyCrust tools through authenticated MCP without mixing scopes or side effects. — [Markdown](https://heycrust.com/docs/markdown/mcp)
- [Account and billing](https://heycrust.com/docs/account): Manage workspace access and HeyCrust subscriptions separately from partner payments. — [Markdown](https://heycrust.com/docs/markdown/account)
- [Help and reference](https://heycrust.com/docs/help): Diagnose sources, attribution, earnings and integration problems using observed facts. — [Markdown](https://heycrust.com/docs/markdown/help)
- [get_overview](https://heycrust.com/docs/mcp/get-overview): Returns the requested window, current MRR, estimated ARR/ARPU/LTV, subscription/shop counts, observed installs/uninstalls, collections and MRR movements. — [Markdown](https://heycrust.com/docs/markdown/mcp/get-overview)
- [get_mrr_history](https://heycrust.com/docs/mcp/get-mrr-history): Returns months from the monthly MRR series plus app scope and dataStatus.. — [Markdown](https://heycrust.com/docs/markdown/mcp/get-mrr-history)
- [get_churn_analysis](https://heycrust.com/docs/mcp/get-churn-analysis): Returns definition, monthlyChurn and uninstallReasons. — [Markdown](https://heycrust.com/docs/markdown/mcp/get-churn-analysis)
- [get_retention](https://heycrust.com/docs/mcp/get-retention): Returns revenueRetention, revenueRetentionDefinition, installCohorts and funnel. — [Markdown](https://heycrust.com/docs/markdown/mcp/get-retention)
- [get_trials](https://heycrust.com/docs/mcp/get-trials): Returns trackingSince and observed trial totals/conversion/plan statistics. — [Markdown](https://heycrust.com/docs/markdown/mcp/get-trials)
- [list_customers](https://heycrust.com/docs/mcp/list-customers): Returns matching customer/install rows and totals, with app scope and dataStatus. — [Markdown](https://heycrust.com/docs/markdown/mcp/list-customers)
- [get_customer](https://heycrust.com/docs/mcp/get-customer): Returns the matched installation/customer detail or a lookup error. — [Markdown](https://heycrust.com/docs/markdown/mcp/get-customer)
- [list_events](https://heycrust.com/docs/mcp/list-events): Returns total and events, plus scope/dataStatus. — [Markdown](https://heycrust.com/docs/markdown/mcp/list-events)
- [list_apps](https://heycrust.com/docs/mcp/list-apps): Returns workspace apps, configuration, receipt observations, history coverage, contact counts and uninstall-watch information. — [Markdown](https://heycrust.com/docs/markdown/mcp/list-apps)
- [get_setup_guide](https://heycrust.com/docs/mcp/get-setup-guide): Returns app identity, observations/sources, app-specific pixel/identify/backfill/uninstall snippets, custom event examples and the setup instructions. — [Markdown](https://heycrust.com/docs/markdown/mcp/get-setup-guide)
- [set_client_secret](https://heycrust.com/docs/mcp/set-client-secret): Returns ok and a note about later merchant-session verification, or an app-ownership error.. — [Markdown](https://heycrust.com/docs/markdown/mcp/set-client-secret)
- [list_flows](https://heycrust.com/docs/mcp/list-flows): Returns existing workspace Flows, their current summaries and execution-scope review state.. — [Markdown](https://heycrust.com/docs/markdown/mcp/list-flows)
- [get_flow](https://heycrust.com/docs/mcp/get-flow): Returns flow, latest definition, node summaries, execution scope and the version that needs review when applicable.. — [Markdown](https://heycrust.com/docs/markdown/mcp/get-flow)
- [list_flow_templates](https://heycrust.com/docs/mcp/list-flow-templates): Returns actual template keys, names, descriptions and full example definitions.. — [Markdown](https://heycrust.com/docs/markdown/mcp/list-flow-templates)
- [create_flow](https://heycrust.com/docs/mcp/create-flow): Returns ok, flowId, status and the next review step, or definition validation errors.. — [Markdown](https://heycrust.com/docs/markdown/mcp/create-flow)
- [update_flow](https://heycrust.com/docs/mcp/update-flow): Returns ok/version or an error with validation details.. — [Markdown](https://heycrust.com/docs/markdown/mcp/update-flow)
- [set_flow_status](https://heycrust.com/docs/mcp/set-flow-status): Returns the saved status or a gating/scope-review/validation error.. — [Markdown](https://heycrust.com/docs/markdown/mcp/set-flow-status)
- [list_flow_runs](https://heycrust.com/docs/mcp/list-flow-runs): Returns runs with current saved status/step/wake information. — [Markdown](https://heycrust.com/docs/markdown/mcp/list-flow-runs)
- [list_flow_messages](https://heycrust.com/docs/mcp/list-flow-messages): Returns message records for the requested status and Flow. — [Markdown](https://heycrust.com/docs/markdown/mcp/list-flow-messages)
- [send_flow_message](https://heycrust.com/docs/mcp/send-flow-message): Returns ok/sentTo or a delivery/eligibility error. — [Markdown](https://heycrust.com/docs/markdown/mcp/send-flow-message)
- [dismiss_flow_message](https://heycrust.com/docs/mcp/dismiss-flow-message): Returns ok or a state/ownership error.. — [Markdown](https://heycrust.com/docs/markdown/mcp/dismiss-flow-message)
- [preview_flow_email](https://heycrust.com/docs/mcp/preview-flow-email): Returns merchant plus rendered subject/body, or merchant plus an AI draft when brief was supplied.. — [Markdown](https://heycrust.com/docs/markdown/mcp/preview-flow-email)
- [draft_winback](https://heycrust.com/docs/mcp/draft-winback): Returns messageId, draft and toEmail with a next-review instruction, or an error such as no matching/churned merchant.. — [Markdown](https://heycrust.com/docs/markdown/mcp/draft-winback)
- [import_contacts](https://heycrust.com/docs/mcp/import-contacts): Returns imported count. — [Markdown](https://heycrust.com/docs/markdown/mcp/import-contacts)
- [get_affiliate_partner_quality](https://heycrust.com/docs/mcp/get-affiliate-partner-quality): Returns definitionVersion, scope, cohort, generatedAt, sourceAsOf, coverage, summaries, items and cursor metadata. — [Markdown](https://heycrust.com/docs/markdown/mcp/get-affiliate-partner-quality)
- [GET programs](https://heycrust.com/docs/api/get-programs): List visible program records for the credential's app. — [Markdown](https://heycrust.com/docs/markdown/api/get-programs)
- [GET programs/:id](https://heycrust.com/docs/api/get-programs-id): Read one program owned by the credential's app. — [Markdown](https://heycrust.com/docs/markdown/api/get-programs-id)
- [GET memberships](https://heycrust.com/docs/api/get-memberships): List partner membership summaries for the app. — [Markdown](https://heycrust.com/docs/markdown/api/get-memberships)
- [POST memberships](https://heycrust.com/docs/api/post-memberships): Provision an app's partner membership. Account verification/claim and term acceptance still affect eligibility. — [Markdown](https://heycrust.com/docs/markdown/api/post-memberships)
- [GET memberships/:id](https://heycrust.com/docs/api/get-memberships-id): Read a partner membership and its associated terms. — [Markdown](https://heycrust.com/docs/markdown/api/get-memberships-id)
- [PATCH memberships/:id](https://heycrust.com/docs/api/patch-memberships-id): Update the group or manual-claim preference for a membership. — [Markdown](https://heycrust.com/docs/markdown/api/patch-memberships-id)
- [GET memberships/:id/terms](https://heycrust.com/docs/api/get-memberships-id-terms): Read the selected membership's terms from its detail response. — [Markdown](https://heycrust.com/docs/markdown/api/get-memberships-id-terms)
- [PATCH memberships/:id/terms](https://heycrust.com/docs/api/patch-memberships-id-terms): Save prospective individual terms for a membership. Existing saved referral contracts are not silently rewritten. — [Markdown](https://heycrust.com/docs/markdown/api/patch-memberships-id-terms)
- [GET referrals](https://heycrust.com/docs/api/get-referrals): List observed/submitted referral summaries for the app. — [Markdown](https://heycrust.com/docs/markdown/api/get-referrals)
- [GET referrals/:id](https://heycrust.com/docs/api/get-referrals-id): Read a referral and its current decision/evidence state. — [Markdown](https://heycrust.com/docs/markdown/api/get-referrals-id)
- [POST referrals](https://heycrust.com/docs/api/post-referrals): Submit a manual client claim for verification. This is not a verified installation or automatic commission. — [Markdown](https://heycrust.com/docs/markdown/api/post-referrals)
- [GET commissions](https://heycrust.com/docs/api/get-commissions): List signed commission entry summaries, with current hold/review status. — [Markdown](https://heycrust.com/docs/markdown/api/get-commissions)
- [POST bonuses](https://heycrust.com/docs/api/post-bonuses): Grant a positive one-time bonus under the eligible membership's current contract and hold rules. — [Markdown](https://heycrust.com/docs/markdown/api/post-bonuses)
- [GET payouts](https://heycrust.com/docs/api/get-payouts): List payout summaries, including derived payment/confirmation states. — [Markdown](https://heycrust.com/docs/markdown/api/get-payouts)
- [GET payouts/:id](https://heycrust.com/docs/api/get-payouts-id): Read payout history, payment reports and receipt/dispute state. — [Markdown](https://heycrust.com/docs/markdown/api/get-payouts-id)
- [Your first workspace](https://heycrust.com/docs/getting-started/first-workspace): Connect your Shopify app and verify the sources before operating a program. — [Markdown](https://heycrust.com/docs/markdown/getting-started/first-workspace)
- [Find your way around](https://heycrust.com/docs/getting-started/navigation): Understand the owner workspace, teammate access and partner portal. — [Markdown](https://heycrust.com/docs/markdown/getting-started/navigation)
- [Connect and manage Shopify apps](https://heycrust.com/docs/app-owners/connect-shopify): Use the correct Partner organization and app identity for your Shopify source. — [Markdown](https://heycrust.com/docs/markdown/app-owners/connect-shopify)
- [Verify data sources](https://heycrust.com/docs/app-owners/source-verification): Read source recency, history continuity and unknown states correctly. — [Markdown](https://heycrust.com/docs/markdown/app-owners/source-verification)
- [Understand analytics and customers](https://heycrust.com/docs/app-owners/analytics): Read the selected app and time window before acting on a metric. — [Markdown](https://heycrust.com/docs/markdown/app-owners/analytics)
- [Build and review Flows](https://heycrust.com/docs/app-owners/flows): Use observed triggers and review messages before consequential delivery. — [Markdown](https://heycrust.com/docs/markdown/app-owners/flows)
- [Sender settings and delivery](https://heycrust.com/docs/app-owners/sender-and-delivery): Configure merchant email and Slack using the workspace controls. — [Markdown](https://heycrust.com/docs/markdown/app-owners/sender-and-delivery)
- [Create programs and commission contracts](https://heycrust.com/docs/app-owners/programs-and-terms): Configure program rewards and payment policy before accepting partners. — [Markdown](https://heycrust.com/docs/markdown/app-owners/programs-and-terms)
- [Verify affiliate tracking](https://heycrust.com/docs/app-owners/affiliate-tracking): Check attribution and collection evidence before distributing referral links. — [Markdown](https://heycrust.com/docs/markdown/app-owners/affiliate-tracking)
- [Connect an existing listing export](https://heycrust.com/docs/app-owners/bigquery): Use your existing GA4 and BigQuery setup for Shopify listing attribution. — [Markdown](https://heycrust.com/docs/markdown/app-owners/bigquery)
- [Manage partners and client referrals](https://heycrust.com/docs/app-owners/partners-and-referrals): Review membership eligibility and attribution before rewarding a referral. — [Markdown](https://heycrust.com/docs/markdown/app-owners/partners-and-referrals)
- [Read and correct commissions](https://heycrust.com/docs/app-owners/commissions): Tie earned rewards to verified collections and saved contracts. — [Markdown](https://heycrust.com/docs/markdown/app-owners/commissions)
- [Review and report manual payouts](https://heycrust.com/docs/app-owners/manual-payouts): Track external transfers and partner receipt without moving money inside HeyCrust. — [Markdown](https://heycrust.com/docs/markdown/app-owners/manual-payouts)
- [Evaluate partner quality](https://heycrust.com/docs/app-owners/partner-quality): Compare referral cohorts using exact currency amounts and observed coverage. — [Markdown](https://heycrust.com/docs/markdown/app-owners/partner-quality)
- [Import partners and review migration liability](https://heycrust.com/docs/app-owners/imports-and-migration): Preview imported membership/referral evidence before applying it. — [Markdown](https://heycrust.com/docs/markdown/app-owners/imports-and-migration)
- [Publish a marketplace listing](https://heycrust.com/docs/app-owners/marketplace): Opt in with an operational program and review the public snapshot. — [Markdown](https://heycrust.com/docs/markdown/app-owners/marketplace)
- [Grant per-app team access](https://heycrust.com/docs/app-owners/team): Choose the affiliate role and permitted apps deliberately. — [Markdown](https://heycrust.com/docs/markdown/app-owners/team)
- [Register, verify and join a program](https://heycrust.com/docs/affiliates/join): Create or claim your partner account and accept the actual program offer. — [Markdown](https://heycrust.com/docs/markdown/affiliates/join)
- [Use referral links and submit clients](https://heycrust.com/docs/affiliates/promotion): Refer merchants through the correct app program and review claim status. — [Markdown](https://heycrust.com/docs/markdown/affiliates/promotion)
- [Understand your earnings](https://heycrust.com/docs/affiliates/earnings): Read commissions, corrections and payable balance for each program and currency. — [Markdown](https://heycrust.com/docs/markdown/affiliates/earnings)
- [Request payment and confirm receipt](https://heycrust.com/docs/affiliates/payments): Use recipient, invoice and receipt controls for manual payments. — [Markdown](https://heycrust.com/docs/markdown/affiliates/payments)
- [Partner account and private records](https://heycrust.com/docs/affiliates/account-and-privacy): Manage your identity, payment details and recovery without exposing another partner’s data. — [Markdown](https://heycrust.com/docs/markdown/affiliates/account-and-privacy)
- [Credentials and identifiers](https://heycrust.com/docs/developers/credentials): Select the credential accepted by the exact HeyCrust interface. — [Markdown](https://heycrust.com/docs/markdown/developers/credentials)
- [Identify merchants from your backend](https://heycrust.com/docs/developers/identify): Send authenticated merchant contact data with the correct app scope. — [Markdown](https://heycrust.com/docs/markdown/developers/identify)
- [Send backend events](https://heycrust.com/docs/developers/backend-events): Record optional app milestones using authenticated, app-scoped events. — [Markdown](https://heycrust.com/docs/markdown/developers/backend-events)
- [Install optional browser tracking](https://heycrust.com/docs/developers/browser-tracking): Capture embedded app activity without exposing a private workspace key. — [Markdown](https://heycrust.com/docs/markdown/developers/browser-tracking)
- [Forward verified uninstall contact](https://heycrust.com/docs/developers/uninstall-forwarding): Use the token-free uninstall contact path when it suits your app. — [Markdown](https://heycrust.com/docs/markdown/developers/uninstall-forwarding)
- [Submit signed affiliate install claims](https://heycrust.com/docs/developers/install-claims): Bridge real referral evidence to the verified Shopify install for the intended app. — [Markdown](https://heycrust.com/docs/markdown/developers/install-claims)
- [Integrate the affiliate REST API](https://heycrust.com/docs/developers/affiliate-api): Use the supported public contract with app scope, safe retries and exact money. — [Markdown](https://heycrust.com/docs/markdown/developers/affiliate-api)
- [Consume affiliate webhooks](https://heycrust.com/docs/developers/webhooks): Validate the destination and verify signed event bodies before processing them. — [Markdown](https://heycrust.com/docs/markdown/developers/webhooks)
- [Import merchant contacts](https://heycrust.com/docs/developers/contact-import): Enrich merchant contact records without inventing installs or attribution. — [Markdown](https://heycrust.com/docs/markdown/developers/contact-import)
- [Verify your integration end to end](https://heycrust.com/docs/developers/integration-checklist): Record the actual customer-visible result for each enabled source. — [Markdown](https://heycrust.com/docs/markdown/developers/integration-checklist)
- [Connect an MCP client](https://heycrust.com/docs/mcp/connect): Connect supported clients to the current authenticated HeyCrust HTTP endpoint. — [Markdown](https://heycrust.com/docs/markdown/mcp/connect)
- [Use MCP for setup, analysis and Flows](https://heycrust.com/docs/mcp/workflows): Ask the assistant to inspect evidence and review writes before performing them. — [Markdown](https://heycrust.com/docs/markdown/mcp/workflows)
- [Sign-in, recovery and workspace settings](https://heycrust.com/docs/account/access): Use the account path matching your owner, teammate or partner role. — [Markdown](https://heycrust.com/docs/markdown/account/access)
- [Plans and subscription billing](https://heycrust.com/docs/account/plans-and-billing): Understand current platform pricing and live-Flow limits. — [Markdown](https://heycrust.com/docs/markdown/account/plans-and-billing)
- [Data definitions and states](https://heycrust.com/docs/help/data-and-states): Interpret source boundaries, exact money and lifecycle/payment states. — [Markdown](https://heycrust.com/docs/markdown/help/data-and-states)
- [Troubleshoot a missing result](https://heycrust.com/docs/help/troubleshooting): Find the failing boundary before retrying a consequential action. — [Markdown](https://heycrust.com/docs/markdown/help/troubleshooting)
- [Documentation changelog](https://heycrust.com/docs/help/changelog): Track the public documentation’s verified coverage. — [Markdown](https://heycrust.com/docs/markdown/help/changelog)
- [Framework recipes](https://heycrust.com/docs/developers/framework-recipes): Use the current Remix, Node/Express and Rails identification, backfill and uninstall recipes. — [Markdown](https://heycrust.com/docs/markdown/developers/framework-recipes)
- [Flow definition contract](https://heycrust.com/docs/mcp/flow-definition): Author complete nested Flow definitions with the actual schema and cross-field constraints. — [Markdown](https://heycrust.com/docs/markdown/mcp/flow-definition)