Configuration

Configure the Traceway SDK after installation.

Configuration

After installing the SDK, initialize it in your Flutter app before any routes or widgets are built.

Basic setup

Add the initialization call to your main() function or app entry point:

import 'package:traceway/traceway.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  await Traceway.initialize(
    apiKey: 'YOUR_API_KEY',
  );

  runApp(const MyApp());
}

Find your API key in the Traceway dashboard under Project Settings. Each project has a unique key — do not share keys between projects.

Configuration options

[PLACEHOLDER: Full TraceConfig / TracewayConfig options table. Fields to document once confirmed from SDK source: apiKey (required), environment (production/staging/debug), enableShakeToReport, enableCrashReporting, enableFloatingButton, userId, userEmail, metadata/customFields, baseUrl override. Mark each as required or optional with its default value.]

Getting your API key

Open the Traceway platform and sign in
Navigate to your organization and select your project
Go to Project Settings and open the SDK tab
Copy the API key shown there
Paste it as the apiKey value in your initialization call

Never commit your API key to version control. Use environment variables or a secrets manager like flutter_dotenv.

Environments

[PLACEHOLDER: Document how to set environment (production, staging, development/debug) in the SDK config, if supported. Confirm the enum or string values from SDK source.]

Next steps

With the SDK initialized, users can now submit reports. By default, shaking the device opens the Traceway report sheet. See the Flutter SDK guide for full customization options.

← Previous

Web SDK

iOS SDK