Quickstart

This page shows the shortest path from a new project to a verified integration. It takes about 10 minutes.

Step 1: Find your snippetCopy Anchor Link

1. Open your project in ABlyft.
2. Go to Settings → Snippet.
3. Copy the code from Implementation (base snippet). The same page shows your Project/Snippet ID.

The code looks like this (12345678 stands for your project ID):

<script src="https://cdn.ablyft.com/s/12345678.js"></script>

Step 2: Add it to your websiteCopy Anchor Link

Paste the snippet into the <head> of every page you want to test, as early as possible. All options (asynchronous loading, Google Tag Manager, sub-snippets) are described in Embed the snippet.

Step 3: PublishCopy Anchor Link

You normally do not need to do anything: ABlyft publishes automatically when your project changes, and creates the first snippet when the project is created. If you want to be sure, check Last published on Settings → Snippet. Details: Publishing.

Step 4: Verify the installationCopy Anchor Link

1. Open your website with ?ablyft_check=true in the URL and, in the browser console, run ablyft.get('data'). If you see your project ID, the snippet is loaded. All checks are described in Verify the integration.
2. Open the Live Log of your project in ABlyft to see events arrive while you use your website.

Step 5: Create a test goalCopy Anchor Link

Create a goal that you can trigger on purpose, to prove that events reach ABlyft.

1. Create a goal of type Custom with an API Name, for example test-goal (see Configure goals).

2. Attach it to an experiment.

3. Trigger it from the browser console or from your code:

   Copy Text

   window.ablyft = window.ablyft || [];
   window.ablyft.push({ eventType: 'custom', eventName: 'test-goal' });

4. Check the Live Log. More on goals: Custom goals.

Next stepsCopy Anchor Link