Introduction

CAUTION

When using any Zoho People API with connection support in a custom function, webhook, or widget, ensure that the 'ZSOID' of the extension organization is passed using the 'portalId' key during testing.

Once testing is complete, make sure to remove the 'portalId' parameter before publishing or deploying the extension to the customer.

Accessing Sigma and Initiating Test Enviroment

1. After logging into your Zoho People account, in a new tab, navigate to sigma.zoho.com (Zoho Sigma—Zoho's cloud-based extension development platform.)
   
2. Hover pointer over your extension and click on the Pencil (edit) icon.
   
3. This will load the respective extension enviroment. This will also include the Test Your Extension button on the top-right corner, click on the button to proceed.
   
4. A sandbox organization will be created for you to test your extension. 
   
5. If any issues occur, go back to your Extensions page and make the necessary changes.
   

NOTE
Depending on the type (external or internal) the steps for testing will vary.

1. External Widgets/Web Tabs

For external-type widgets or web tabs:

1. No additional configuration is required inside the widget itself.
2. Just configure the Connected App in the Extension Org.
3. Create the widget/web tab.
4. Launch your Extension Test Environment and navigate to the designated render area.
   

For internal-type widgets (hosted locally or using ZET CLI):

Steps:

1. Configure the Connected App.
2. Create a Widget/Web Tab (e.g., "Home" type).
3. Click Test Your Extension to access the sandbox environment.
   
   

 Troubleshooting Localhost Connection Issue

If you see an error like:

“127.0.0.1 refused to connect” — this means your local development server isn’t running or accessible. Read below for solution (Run a Local Server).

Follow these steps:

1. Ensure you’ve created the widget zip using the ZET-CLI tool.
2. Open your terminal.
3. Navigate to your widget project directory.
4. Run the following command:
   

1. zet run

5. Copy and paste your local host address in the a new browser tab.
   
6. Click Advanced, followed by Proceed to 127.0.0.1.
   
7. Now Navigate to your extension test environment browser tab.
8. Reload your browser tab to view.