Skip to main content

Quick Start

Get Break Ground running in your application in five minutes.

Prerequisites​

Before you begin, ensure you have:

  • A BreakGround account (sign up from the dashboard)
  • Access to your web application's HTML source or template
  • A modern web browser (Chrome, Firefox, Safari, or Edge)

Step 1: Create Your Account​

  1. Navigate to the BreakGround dashboard and register your organization.
  2. Verify your email address and set a password.
  3. Log in to access the dashboard.

Step 2: Get Your API Key​

  1. In the dashboard, go to Settings > API Keys.
  2. Click Generate New Key.
  3. Copy the generated key (format: wfx_ followed by 64 hex characters). Store it securely — you will not be able to view it again.

Step 3: Add the SDK Snippet​

Paste the following snippet inside the <head> section of your HTML:

<script>
  (function (w, d, s, o, f, js, fjs) {
    w["DAPObject"] = f;
    w[f] =
      w[f] ||
      function () {
        (w[f].q = w[f].q || []).push(arguments);
      };
    w[f].l = 1 * new Date();
    js = d.createElement(s);
    fjs = d.getElementsByTagName(s)[0];
    js.id = f;
    js.src = o;
    js.async = 1;
    fjs.parentNode.insertBefore(js, fjs);
  })(window, document, "script", "https://cdn.example.com/sdk.js", "DAP");
  DAP("init", { tenantKey: "YOUR_TENANT_KEY" });
</script>

Replace YOUR_TENANT_KEY with the API key from Step 2.

Step 4: Verify the Installation​

  1. Open your application in a browser.
  2. Open the developer console (F12 or Cmd+Option+I).
  3. Type window.DAP and press Enter. You should see the DAP function object.
  4. To enable verbose logging, initialize with debug: true:
DAP("init", { tenantKey: "YOUR_TENANT_KEY", debug: true });

Step 5: Create Your First Flow​

  1. Open the BreakGround dashboard and navigate to Flows > Create New Flow.
  2. Install the BreakGround Chrome Extension if prompted.
  3. Enter the URL of the page where the flow should start.
  4. Use the visual builder to select elements and add steps.
  5. Preview the flow, then click Publish to make it live.

Your users will now see the flow when they match the targeting rules. For a full list of configuration options, see the SDK Configuration reference.