Fix SharePoint Web Part Works Locally but Not in Online Workbench
Question details
A custom SharePoint Framework (SPFx) web part functions correctly in the local development workbench but fails to load or work properly when added to a live SharePoint online site.

- Product
- Microsoft SharePoint
- Device & OS
- not provided
- Scenario
- Deploying and testing a newly developed custom SPFx web part in a live SharePoint Online environment.
- Observed behavior
- The web part loads successfully during local testing but encounters errors, fails to render, or remains invisible in the SharePoint online workbench.
Ensure you have SharePoint administrator privileges and access to your tenant's App Catalog to verify package deployments and approve necessary API permissions.
Verify App Catalog Deployment and API Permissions
Check that the SPFx package was successfully deployed to the tenant App Catalog and that all required API permissions are approved.
Web parts often rely on specific backend APIs that require explicit admin consent. Even if the package is deployed successfully, failing to approve these permissions in the SharePoint Admin Center will cause the web part to fail in the online workbench.
Navigate to your SharePoint Admin Center, go to 'More features', and open the 'Apps' section. Click 'App Catalog' and ensure your .sppkg file is uploaded, deployed, and shows no errors in the 'App Package Error Message' column.
In the SharePoint Admin Center, expand the 'Advanced' menu on the left sidebar and click 'API access'. Review the 'Pending requests' section and approve any API permissions requested by your custom web part.
If the package was built using development settings, it might fail online. Open your local terminal and run 'gulp clean', followed by 'gulp bundle --ship' and 'gulp package-solution --ship' to create a clean production build before re-uploading.
Consult the SharePoint Development Community
Reach out to Microsoft specialists for complex code or configuration issues that cannot be resolved through standard deployment checks.
Need a Reliable and Free Office Suite for Your Daily Work?
While you troubleshoot your SharePoint development environment, consider equipping your team with WPS Office. It is a powerful, lightweight, and free alternative to Microsoft Office that easily handles all your document, spreadsheet, and presentation needs.
- 1. Download the Installer: Visit the official WPS Office website and download the free installation package for your operating system.
- 2. Install WPS Office: Run the downloaded installer and follow the quick on-screen instructions to set up the software.
- 3. Open Your Files: Launch WPS Office and directly open your existing Microsoft Office documents without worrying about formatting loss.

Frequently Asked Questions
Can I test my SPFx web part against live SharePoint data without deploying it?
Yes. You can run 'gulp serve' locally and then navigate to 'https://[your-tenant].sharepoint.com/_layouts/15/workbench.aspx' in your browser. This online workbench connects to live SharePoint data while serving the web part assets directly from your local development environment.
Why does my web part show a 'manifest not found' error online?
This usually happens if the CDN configuration is incorrect, or if the assets were not properly packaged and deployed. Ensure you have run the build commands with the '--ship' flag ('gulp bundle --ship' and 'gulp package-solution --ship') so the assets are bundled within the package or correctly referenced to your CDN.
How long does it take for API permission approvals to take effect?
Once you approve API permissions in the SharePoint Admin Center, it can take up to 15-30 minutes for the changes to fully propagate across the tenant. If your web part still fails immediately after approval, wait a short while and refresh.




