Skip to content

Conversation

@OlivierGuntenaar
Copy link

Summary

Updates the self-hosted Shopify integration docs to reflect Shopify’s CLI-managed app configuration, clarifies visibility conditions, and adds concrete steps to enable the feature in Chatwoot.

Why

Shopify migrated app configuration from the Partner Dashboard to CLI-managed config (config-as-code). The existing doc showed outdated dashboard steps. The new flow aligns with current Shopify guidance and reduces setup confusion.

What changed

  • Rewrote setup to use Shopify CLI (create or link via shopify app init).
  • Added shopify.app.toml example with placeholders and required callback.
  • Added deploy step (shopify app deploy).
  • Moved “find Client ID/Secret” to after deploy (for CLI-created apps).
  • Kept app creation screenshot; removed outdated dashboard configuration screenshots.
  • Added instructions to set SHOPIFY_CLIENT_ID and SHOPIFY_CLIENT_SECRET in Super Admin.
  • Added FRONTEND_URL requirement and service restart note.
  • Added visibility requirement: enable shopify_integration via Rails console, with snippet to open the console and find Account.first.id.

Affected doc

  • self-hosted/configuration/features/integrations/shopify-integration-setup.mdx

How to test

  1. Create or link a Shopify app:
    • Create in Partner Dashboard or via CLI.
    • Initialize locally with shopify app init.
  2. Edit shopify.app.toml:
    • Set application_url and auth.redirect_urls to your Chatwoot domain and <domain>/shopify/callback.
  3. Deploy:
    • shopify app deploy
    • Then retrieve Client ID/Secret in Dev Dashboard: https://dev.shopify.com/dashboard → Apps → your app → Settings.
  4. In Chatwoot Super Admin → Settings → Shopify:
    • Set SHOPIFY_CLIENT_ID and SHOPIFY_CLIENT_SECRET.
    • Ensure FRONTEND_URL=https://<your-domain> is set at the web process; restart service.
  5. Enable feature for your account (Rails console):
    • Account.first.idaccount = Account.find(<ID>)
    • account.enable_features!("shopify_integration")
    • Restart service if needed.
  6. Verify:
    • Integrations → Shopify tile visible.
    • Click Connect and complete OAuth.

References

… steps

Switches Shopify setup to CLI-managed flow, removes outdated screenshots, adds Dev Dashboard path for credentials after deploy, adds CLI init/create flows, TOML example, deploy step, FRONTEND_URL note, and Rails console + feature flag steps.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant