Kursaha-sdk NPM

Kursaha Node.js SDK

Welcome to the Kursaha Node.js SDK! This SDK provides a seamless way to integrate Kursaha's powerful event and customer data management capabilities into your Node.js application. With this SDK, you can easily send event signals, customer data, and more to the Kursaha platform.

Installation

To get started, install the Kursaha SDK via npm:

npm install kursaha-sdk --save

Getting Started

Initialize the SDK

First, require and configure the Kursaha SDK in your application. You need to provide your API key to authenticate with the Kursaha platform.

...
import KursahaClient from "kursaha-sdk";
...

const Kursaha = require('kursaha-sdk')

// Initialize the SDK with your API key
const kursahaClient = new Kursaha('<YOUR-API-KEY>')

Start Using the SDK
You can now start sending event signals and customer data to Kursaha. See the methods section for details.

Methods

Signal Start Event

Send a signal to start an event flow. This method allows you to track various events within your application.

const signal = {
  customerId: '<unique-customer-id>',
  eventType: '<event-type>',
  data: {},
  eventflowIdentifier: '<uuid>',
}

kursahaClient.signal(signal)

Sending Customer Data

Send customer data to Kursaha to keep your records up-to-date and enhance your customer engagement strategies.

const customerData = {
  customerId: '<unique-customer-id>',
  customerData: {
    email: 'j.doe@swq.com',
    phoneNumber: '+911002220000',
    firstName: 'John',
    lastName: 'Doe',
    gender: '',
    dob: '',
    city: '',
    state: '',
    country: '',
    zip: '',
  },
}

kursahaClient.sendCustomerData(customerData)

Sending Events

Transmit events to Kursaha to track user actions and interactions within your application. These actions will be recoreded in cohort.

const event = {
  customerId: '<unique-customer-id>',
  eventType: '<event-type>',
  data: {
    price: 200,
    brand: 'something',
    productId: '',
    category: '',
    subCategory1: '',
    subCategory2: '',
    subCategory3: '',
  },
}

kursahaClient
  .sendEvent(event)
  .then((response) => {
    console.log('Event sent successfully:', response)
  })
  .catch((error) => {
    console.error('Error sending event:', error)
  })

Configuration

Before using the SDK, make sure to replace <YOUR-API-KEY> with your actual Kursaha API key. Ensure that your API key is kept secure and not exposed in your codebase.