connect_x_mobile_sdk 1.1.5

ConnectX Mobile SDK for Mobile.

ConnectX Mobile SDK

The ConnectX Mobile SDK is a Flutter library designed to simplify the integration of ConnectX's tracking and data management features into your mobile applications. It provides functionalities for tracking events, managing user data, and interacting with backend APIs, ensuring seamless user analytics and experience tracking.

---

Features

• User Event Tracking: Track user actions, behaviors, and interactions within your app.
• Create Customer: Identify and manage user details across sessions.
• Open Ticket: Open support tickets programmatically.
• Create or Update Custom Records: Create and edit records in bulk.
• Get Unknown ID: Generates and returns a unique identifier.

---

Getting started

Prerequisites

• A valid ConnectX API Token and Organize ID are required for initialization.
• Your Flutter environment must be set up, including the Flutter SDK.

Installation

Run the following command to add the package to your project:

flutter pub add connect_x_mobile_sdk

Run flutter pub get if the package is not fetched automatically.

Usage

1. Import the Library

import 'package:connect_x_mobile_sdk/connect_x_mobile_sdk.dart';

2. Initialize the SDK

Before using any SDK methods, initialize it with your token and organize ID. Note: You can generate the YOUR_API_TOKEN from Connect-X by navigating to: Organization Settings → SDK Tracking.

void main() async {
  await ConnectXMobileSdk.initialize(
    'YOUR_API_TOKEN',
    'YOUR_ORGANIZE_ID',
    env='YOUR_ENV' //optional
  );
  runApp(MyApp());
}

3. Track Events

final trackingData = {
  'cx_event': 'YOUR_EVENT',
  'cx_source': 'YOUR_SOURCE',
  // other Activity field
};

bool success = await ConnectXMobileSdk.cxTracking(trackingData);
if (success) {
  print('Event tracked successfully!');
}

4. Create Customer

await ConnectXMobileSdk.cxIdentify(
  {
    'key':'cx_email',
    'customers' { // The value for the Customer object.
      'cx_Name': 'customerName',
      'cx_firstName': 'customerFirstName',
      'cx_mobilePhone': '0000000000',
      'cx_email': 'customerEmail'
      //... Other Customer Field
    },
    // Optional
    'tracking': { // The value for the Activities object.
      'cx_value': '',
      'cx_tag': ['Keyword1', 'Keyword2', 'Keyword3'],
      'cx_prospect': true
      // ... Other Activity Field
    },
    // Optional
    'form': { // The value for the Form object.
      'cx_subject': 'mobile',
      'cx_desc': 'mobile'
      // ... Other Form Field.
    },
    // Optional
    'options':  {
      'updateCustomer': false, // Enable/Disable Customer Data Update
      'customs': [
        //For adding values in the Object that you want to reference with the Customer Object.
        {
          'customObjectA': {'cx_Name': 'Keyword'},
        },
        {
          'customObjectB': {'cx_Name': 'Keyword'},
        }
      ],
      'updateSomeFields': {
        // For adding cases where you want to update some values in the Customers Object.
        'bmi': 25,
        'weight': 55
      }
    }
 }
);
if (success) {
  print('User identified successfully!');
}

5. Open Tickets

bool success = await ConnectXMobileSdk.cxOpenTicket({
  'key': 'cx_Name',
  'customers': {
    'cx_Name': 'customerName',
    'cx_firstName': 'customerFirstName',
    'cx_phone': 'customerPhone',
    'cx_mobilePhone': 'customerMobilePhone',
    'cx_email': 'customerEmail',
  },
  'ticket': {
    'cx_subject': 'test subject',
    'cx_socialAccountName': '[e-mail]',
    'cx_socialContact': '[e-mail]',
    'cx_channel': 'email',
    'email': {
      'text': 'text',
      'html': '<b>Content</b>',
    },
  },
  'lead': {
    'cx_email': '[e-mail]',
    'cx_channel': 'test_connect_email',
  },
  'customs': [
    {
      'customObjectA': {'cx_Name': 'Test'},
    },
    {
      'customObjectB': {'cx_Name': 'Test'},
    }
  ]
});

if (success) {
  print('Ticket opened successfully!');
}

6. Create or Update Custom Objects

To create a new custom object, you must generate a unique referenceId to identify the record. If you pass a docId, the object is updated instead of being created.

var res = await ConnectXMobileSdk.cxCreateRecords(objectName, [ // limit 200 rows
  {
    'attributes': {'referenceId': 'UNIQUE_ID'}, // Replace with your unique ID generation logic
    'cx_Name': cxName,
    'docId': docId, // Pass null for create mode; pass a valid ID for edit mode
  }
]);

print("Result: $res");

7. Get Unknown ID

This method generates and returns a unique identifier.

String unknownId = await ConnectXMobileSdk.getUnknownId() ?? '';

License