Installation

Welcome to Convertly, your dedicated tool for simplifying event analytics.

This documentation provides detailed instructions on how to install and use Convertly to track user interactions and activities in your SaaS app.

Integrating Convertly with your application is straightforward. You have a few options!

Option 1: Add us as a Destination in Segment

The official documentation is on Segment's site here. Or you can read the instructions below.

  1. From the Destination catalog page in the Segment app, search for Convertly

  2. Select and click Add Destination

  3. Select an existing Source to connect to.

  4. 4. Go to the API Keys page in tryConvertly.com

  5. Copy your API key

  6. Enter the API key in the destination settings in Segment

Option 2: Using the NPM module for a React app

npm install convertly

Now, add the provider in your React app

import { ConvertlyProvider } from 'convertly';

export default function App() {
  return (
      <ConvertlyProvider apiKey='key-XXXXX'>
          <BrowserRouter />
      </ConvertlyProvider>
  )
}

Make sure to replace key-XXXXX with your token from Convertly.

Now you can use Convertly throughout a React app.

Alternatively, you can add the script directly instead of using the NPM module.

Option 3: Adding the Script

To get started, include the following script tag in the <head> or just before the closing </body> tag of your HTML document:

<script src="https://convertly.sfo3.cdn.digitaloceanspaces.com/convertly.umd.js"></script>

After adding the script, initialize Convertly with your unique token:

<script>
  var convertly = new Convertly({ token: 'key-YOURKEY' });
</script>

Replace key-YOURKEY with the actual token provided to you on the Convertly dashboard. This initializes the Convertly object, making it easy to track events within your application.

NextIdentifying Users

Last updated