promote-js v0.0.28

Promote JavaScript SDK

Promote helps you discover, recruit, engage, track, and manage top-performing affiliates, referrals, resellers, and more with a single partner management platform.

The JavaScript SDK allows you to automatically capture leads attributes, customer attributes and actions on your site or application.

It can be used both in Node.js or in the browser.

Getting Started

Create a Promote account and get your API key

Installation

Client(Browser)

Include the script into your head element

<script src="https://unpkg.com/promote-js/dist/promote.js"></script>

Node

npm install promote-js

Tracking Events with the SDK

After installing the sdk as stated above, tracking events can be performed very easily.

To track sign up on the browser PromoteJS.trackSignUp("customername","customerEmail");

or on Node as follows:

import PromoteJS from "promote-js";

PromoteJS.trackSignUp("customername","customerEmail");

Get the currently active Promoter Reference:

let activePromoterId = PromoteJS.getActivePromoterReference(); //Returns undefined or data

Set the retrieved activePromoterId as client_reference_id when initiating your stripe checkout in the backend

If you are using stripe.redirectToCheckout();

Pass the promoter reference as an optional argument to the redirecToCheckOut function like this

stripe.redirectToCheckout(
  ...
                          
  successUrl: 'https://example.com/success',
  cancelUrl: 'https://example.com/cancel',
  clientReferenceId: PromteJS.getActivePromoterReference(); //Returns undefined or data
);

If you are taking care of the checkout from the backend, use client_reference_id.