Sandbox Mode

Test imports safely without affecting production data or webhooks.

Available on Starter plans and above

Overview

Sandbox mode provides complete isolation for testing your CSV import integration. When using sandbox mode:

  • ✓Sandbox API keys are prefixed with sk_sandbox_
  • ✓Production webhooks are never triggered
  • ✓Sandbox imports don't count against your monthly quota
  • ✓Webhook payloads include environment: "SANDBOX"

Getting Started

1
Create a Sandbox API Key

Go to Dashboard → API Keys and create a new key. Select "Sandbox" as the environment.

Sandbox keys are prefixed with sk_sandbox_
2
Configure Sandbox Webhook (Optional)

Go to Settings → Sandbox Mode to configure a separate webhook URL for sandbox imports.

Sandbox Webhook URL

If not configured, webhook delivery will be skipped for sandbox imports.

3
Use Sandbox Environment in SDK

Initialize the SDK with environment: 'sandbox':

javascript
Rowporter.init({
  templateId: 'tpl_abc123',
  environment: 'sandbox', // Use sandbox mode
  
  onComplete: (result) => {
    console.log('Environment:', result.environment); // 'SANDBOX'
    console.log('Import completed in sandbox');
  },
  
  onError: (error) => {
    console.error('Sandbox error:', error);
  }
});

API Reference

SDK Options

OptionTypeDefaultDescription
environmentstring'production''production' or 'sandbox'

Webhook Payload

Sandbox imports include the environment in the webhook payload:

json
{
  "event": "import.completed",
  "environment": "SANDBOX",
  "data": {
    "importId": "imp_abc123",
    "templateId": "tpl_xyz789",
    "rows": [...]
  }
}

Best Practices

✓

Use separate webhook endpoints

Configure a dedicated sandbox webhook URL that points to your staging environment.

✓

Check the environment field

Always verify environment in webhook payloads before processing data in production.

Store API keys securely

Keep sandbox keys separate from production keys in your configuration.

← SDK ReferenceWebhooks