Setup and Integrations
Retrieve Faurya tracking, goal, widget, AI crawler, revenue integration, and payment webhook setup instructions from the CLI.
Setup and Integrations
Setup and integration commands are read-only. They return instructions or configuration guidance when you run them, but this documentation shows only the commands to request that guidance.
Tracking setup
platform is required. Supported values are script, npm, nextjs, react, vue, svelte, spa, react_native, shopify, wordpress, and custom. Optional environment values are production, development, and both.
faurya website setup tracking <websiteId> --input '{"platform":"script","environment":"production"}'Tracking code
codeType is required. Supported values are script, script_localhost, npm_install, npm_init, npm_env, web_init, react_init, nextjs_init, react_native_provider, track_event, track_pageview, identify, flush, spa_tracking, cross_domain, and custom_storage.
faurya website setup code <websiteId> --input '{"codeType":"script"}'faurya website setup code <websiteId> --input '{"codeType":"nextjs_init"}'Tracking configuration
platform is optional and can be web, react_native, or core.
faurya website setup config <websiteId>faurya website setup config <websiteId> --input '{"platform":"web","includeDefaults":true}'Tracking validation
Validation requires platform and either code or configuration. Use --input-file for anything large.
faurya website setup validate <websiteId> --input-file ./tracking-validation.jsonGoal tracking code
platform and goalName are required. Supported platforms are web, react, nextjs, and react_native. Optional method values are client, declarative, and hook.
faurya website setup goal-code <websiteId> --input '{"platform":"web","goalName":"signup"}'Scroll-goal tracking code
platform and goalName are required. Optional fields include threshold, delayMs, elementId, and customProperties.
faurya website setup scroll-goal <websiteId> --input '{"platform":"web","goalName":"scroll_depth","threshold":0.5}'Goal tracking reference
platform is optional and can be web, react_native, or all.
faurya website setup goal-reference <websiteId>faurya website setup goal-reference <websiteId> --input '{"platform":"all"}'AI crawler setup
faurya website setup ai-crawl <websiteId>faurya website setup ai-crawl <websiteId> --input '{"platform":"web"}'AI crawler configuration
faurya website setup ai-crawl-config <websiteId>Widget catalog and embed instructions
faurya website widgets list <websiteId>faurya website widgets embed <websiteId> --input '{"widgetType":"realtime"}'Supported widget types are realtime, analytics, and chart.
Revenue integration list
faurya website integrations list <websiteId>Integration status
faurya website integrations status <websiteId> <provider>Integration setup
faurya website integrations setup <websiteId> <provider>faurya website integrations setup <websiteId> <provider> --input '{"environment":"live"}'Supported provider values are stripe, dodo, lemonsqueezy, creem, polar, paddle, cashfree, razorpay, whop, easytools, and payments_api.
Payment webhook configuration
faurya website integrations webhook <websiteId> <provider>These commands can return setup snippets or instructions when executed. This documentation intentionally does not reproduce command output, webhook payloads, JavaScript, HTML, or provider configuration examples.