Environments

​

Overview

• Code: Shows the environment code for currently selected application that can be used to initialize our Javascript SDK.
• Status: Shows a status if our Javascript SDK was successfully installed or a button to instructions on how to install it.
• Menu:
  • Edit: Opens environment editor.
  • Install: Redirects you to the installation instructions page.
  • Copy Secret: Fetches and copies the environment secret to your clipboard.

​

Configuration

• Environment Type: environment’s type and a badge color to easily recognize this environment across the dashboard. Once environment is created, its type cannot be changed, but you can still modify its colors.
• Title: environment title that is used to identify this environment across the dashboard. This is typically very similar to its type (e.g. Production, Testing, Development).
• Description: an optional description of the environment to make it clear to your team what this environment is used for.
• Website URL: main hostname for your environment’s base URL. This should not contain any subpaths within your application environment.
• URL Base Path: optional environment website URL base path to distinguish organizations or projects across your userbase. For dynamic URL parts use the * or :var wildcards to match any sequence of characters in a URL path. You can use the Test URL option below the input field to test any example URLs.
  • e.g. for URLs like: https://example.com/dashboard/123/workspaces/123/... you should set your URL base path as: /dashboard/*/workspaces/*/ or /dashboard/:orgId/workspaces/:workspaceId/.

​

Environment Types

• Production: Live environment for end users. All data collected here is considered to be of high importance and should be used for analytics and decision-making.
• Testing: Used for QA and automated tests. This environment is used to test new features and verify that there are no regressions.
• Development: For internal development and feature testing. This environment is used by developers to test new features and verify that there are no regressions.
• Staging: Environment that is used to stage new features before they are released to production. This environment is used to test new features before they are released to production.
• Demo: Environment used to showcase application features to potential customers. This environment is used to test new features in a real-world scenario without affecting production data.