Create New User with LightSpeed VT API on Customer Created (Instant) from Customer Fields API

Pipedream makes it easy to connect APIs for LightSpeed VT, Customer Fields and 2,400+ other apps remarkably fast.

Trigger workflow on

Customer Created (Instant) from the Customer Fields API

Next, do this

Create New User with the LightSpeed VT API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Customer Fields trigger and LightSpeed VT action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Customer Created (Instant) trigger
1. Connect your Customer Fields account
Configure the Create New User action
1. Connect your LightSpeed VT account
2. Optional- Configure Is Active
3. Select a Location Id
4. Configure Username
5. Configure Password
6. Configure Email
7. Configure First Name
8. Configure Last Name
9. Optional- Configure Middle Name
10. Optional- Configure Title
11. Optional- Select a Gender
12. Optional- Configure DOB
13. Optional- Select a Language
14. Configure Access Level
15. Optional- Configure Company Name
16. Optional- Select a Team Id
17. Optional- Select a Job Position Id
18. Optional- Configure Hire Date
19. Optional- Configure Start Date
20. Optional- Configure Release Date
21. Optional- Configure Expire Date
22. Optional- Configure Affiliate Id
23. Optional- Configure Vendor Id
24. Optional- Configure Misc 1
25. Optional- Configure Misc 2
26. Optional- Configure Phone 1
27. Optional- Configure Phone 2
28. Optional- Select one or more Content Role Id
29. Optional- Configure Lock Username
30. Optional- Configure Lock Username Password
31. Optional- Configure Force Password Update
32. Optional- Configure Update My Profile
33. Optional- Configure Manage Users
34. Optional- Configure Billing Frequency
35. Optional- Configure Gross Fee Charged
36. Optional- Configure Promo Code
37. Optional- Configure Address 1
38. Optional- Configure Address 2
39. Optional- Configure City
40. Optional- Configure State
41. Optional- Configure ZIP
42. Optional- Configure Country
43. Optional- Configure Mobile
44. Optional- Configure Add Phone
45. Optional- Configure Cell Country
46. Optional- Configure Handle
47. Optional- Configure Hometown
48. Optional- Configure About Me
49. Optional- Configure Facebook
50. Optional- Configure LinkedIn
51. Optional- Configure Instagram
52. Optional- Configure Twitter
53. Optional- Configure Youtube
54. Optional- Configure TikTok
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

Customer Created (Instant) on Customer Fields

Description:Trigger when a new customer is added to the database. [See the documentation](https://docs.customerfields.com/#0824dffa-8d67-4b90-828b-289f7fd46899).

Version:0.0.1

Key:customer_fields-customer-created

View on GitHub

Customer Fields Overview#

The Customer Fields API provides a suite of tools for managing customer data in e-commerce platforms, including custom form fields and data automation. With it, you can efficiently tailor customer interactions, streamline data collection, and enhance the shopping experience. Integrating Customer Fields with Pipedream allows for seamless automation of tasks like syncing data to other platforms, triggering personalized communications, or managing customer segments based on custom field data.

Trigger Code#

import common from "../common/webhook.mjs";
import topics from "../common/topics.mjs";

export default {
  ...common,
  key: "customer_fields-customer-created",
  name: "Customer Created (Instant)",
  description: "Trigger when a new customer is added to the database. [See the documentation](https://docs.customerfields.com/#0824dffa-8d67-4b90-828b-289f7fd46899).",
  type: "source",
  version: "0.0.1",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getResourcesFn() {
      return this.app.listCustomers;
    },
    getResourcesFnArgs() {
      return {
        params: {
          sort_by: "created_at",
          sort_order: "desc",
        },
      };
    },
    getResourcesName() {
      return "customers";
    },
    getTopicName() {
      return topics.CUSTOMERS_CREATE;
    },
    generateMeta(resource) {
      return {
        id: resource.id,
        summary: `New Customer: ${resource.id}`,
        ts: Date.parse(resource.created_at),
      };
    },
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Customer Fields	`app`	`app`	This component uses the Customer Fields app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.

Trigger Authentication#

Customer Fields uses OAuth authentication. When you connect your Customer Fields account, Pipedream will open a popup window where you can sign into Customer Fields and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Customer Fields API.

Pipedream requests the following authorization scopes when you connect your account:

readwrite

About Customer Fields#

Create customer sign-up forms as unique as your business, and save custom data to customer accounts.

Action#

Create New User on LightSpeed VT

Description:Creates a new user in the LightSpeed VT system. [See the documentation](https://lsvtapi.stoplight.io/docs/lsvt-rest-api/26844d671bbcf-create-user)

Version:0.0.1

Key:lightspeed_vt-create-new-user

View on GitHub

LightSpeed VT Overview#

LightSpeed VT is a learning management system (LMS) that provides a platform for delivering interactive training and e-learning experiences. Through the LightSpeed VT API, you can automate access to course catalogs, manage users, track progress and performance, and integrate this data with other systems. On Pipedream, you can leverage this API to create workflows that respond to events in real-time, synchronize training data with other platforms, and enhance the user learning experience with personalized automations.

Action Code#

import {
  GENDER_OPTIONS, LANGUAGE_OPTIONS,
} from "../../common/constants.mjs";
import lightspeedVt from "../../lightspeed_vt.app.mjs";

export default {
  key: "lightspeed_vt-create-new-user",
  name: "Create New User",
  description: "Creates a new user in the LightSpeed VT system. [See the documentation](https://lsvtapi.stoplight.io/docs/lsvt-rest-api/26844d671bbcf-create-user)",
  version: "0.0.1",
  type: "action",
  props: {
    lightspeedVt,
    isActive: {
      type: "boolean",
      label: "Is Active",
      description: "Set to return active or inactive users only.",
      optional: true,
    },
    locationId: {
      propDefinition: [
        lightspeedVt,
        "locationId",
      ],
    },
    username: {
      type: "string",
      label: "Username",
      description: "The username of the new user.",
    },
    password: {
      type: "string",
      label: "Password",
      description: "The password for the new user.",
      secret: true,
    },
    email: {
      type: "string",
      label: "Email",
      description: "The email of the new user.",
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "The first name of the new user.",
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "The last name of the new user.",
    },
    middleName: {
      type: "string",
      label: "Middle Name",
      description: "The middle name of the new user.",
      optional: true,
    },
    title: {
      type: "string",
      label: "Title",
      description: "The title of the new user.",
      optional: true,
    },
    gender: {
      type: "string",
      label: "Gender",
      description: "The gender of the new user.",
      options: GENDER_OPTIONS,
      optional: true,
    },
    dob: {
      type: "string",
      label: "DOB",
      description: "Valid ISO 8601 timestamp, i.e. yyyyy-MM-ddTHH:mm:ssZ - User's date of birth.",
      optional: true,
    },
    language: {
      type: "string",
      label: "Language",
      description: "Default: en-us - Language to set for user - Any valid ISO 639-1 code with region.",
      options: LANGUAGE_OPTIONS,
      optional: true,
    },
    accessLevel: {
      type: "integer",
      label: "Access Level",
      description: "The access level for the new user. [See Access Levels Definition](https://support.lightspeedvt.com/docs/access-level-management)",
      min: 2,
      max: 12,
    },
    companyName: {
      type: "string",
      label: "Company Name",
      description: "The company of the new user.",
      optional: true,
    },
    teamId: {
      propDefinition: [
        lightspeedVt,
        "teamId",
      ],
      optional: true,
    },
    jobPositionId: {
      propDefinition: [
        lightspeedVt,
        "jobPositionId",
      ],
      optional: true,
    },
    hireDate: {
      type: "string",
      label: "Hire Date",
      description: "Valid ISO 8601 timestamp, i.e. yyyyy-MM-ddTHH:mm:ssZ - User's hiring date.",
      optional: true,
    },
    startDate: {
      type: "string",
      label: "Start Date",
      description: "Valid ISO 8601 timestamp, i.e. yyyyy-MM-ddTHH:mm:ssZ - User's starting date.",
      optional: true,
    },
    releaseDate: {
      type: "string",
      label: "Release Date",
      description: "Valid ISO 8601 timestamp, i.e. yyyyy-MM-ddTHH:mm:ssZ - User's release date.",
      optional: true,
    },
    expireDate: {
      type: "string",
      label: "Expire Date",
      description: "Valid ISO 8601 timestamp, i.e. yyyyy-MM-ddTHH:mm:ssZ - User's account expiration date.",
      optional: true,
    },
    affiliateId: {
      type: "string",
      label: "Affiliate Id",
      description: "Affiliate Id associated with creation of user's account.",
      optional: true,
    },
    vendorId: {
      type: "string",
      label: "Vendor Id",
      description: "Custom vendor Id associated with creation of user's account.",
      optional: true,
    },
    misc1: {
      type: "string",
      label: "Misc 1",
      description: "Miscellaneous info field 1.",
      optional: true,
    },
    misc2: {
      type: "string",
      label: "Misc 2",
      description: "Miscellaneous info field 2.",
      optional: true,
    },
    phone1: {
      type: "string",
      label: "Phone 1",
      description: "User's phone number 1.",
      optional: true,
    },
    phone2: {
      type: "string",
      label: "Phone 2",
      description: "User's phone number 2.",
      optional: true,
    },
    contentRole: {
      propDefinition: [
        lightspeedVt,
        "contentRole",
      ],
      optional: true,
    },
    lockUsername: {
      type: "boolean",
      label: "Lock Username",
      description: "Restricts user from changing its username.",
      optional: true,
    },
    lockUsernamePassword: {
      type: "boolean",
      label: "Lock Username Password",
      description: "Restricts user from changing its username and password.",
      optional: true,
    },
    forcePasswordUpdate: {
      type: "boolean",
      label: "Force Password Update",
      description: "Forces user to update its password upon first sign in.",
      optional: true,
    },
    updateMyProfile: {
      type: "boolean",
      label: "Update My Profile",
      description: "Restricts user from updating its profile.",
      optional: true,
    },
    manageUsers: {
      type: "boolean",
      label: "Manage Users",
      description: "Restricts user from managing other users.",
      optional: true,
    },
    billingFrequency: {
      type: "integer",
      label: "Billing Frequency",
      description: "Use to specify the billing schedule frequency in months. **Required if your API settings are set to require this parameter**.",
      optional: true,
    },
    grossFeeCharged: {
      type: "string",
      label: "Gross Fee Charged",
      description: "Use to specify the fee per user. **Required if your API settings are set to require this parameter**.",
      optional: true,
    },
    promoCode: {
      type: "string",
      label: "Promo Code",
      description: "Promo code used during user's account creation.",
      optional: true,
    },
    address1: {
      type: "string",
      label: "Address 1",
      description: "User's address line 1.",
      optional: true,
    },
    address2: {
      type: "string",
      label: "Address 2",
      description: "User's address line 2.",
      optional: true,
    },
    city: {
      type: "string",
      label: "City",
      description: "User's city.",
      optional: true,
    },
    state: {
      type: "string",
      label: "State",
      description: "User's state or province.",
      optional: true,
    },
    zip: {
      type: "string",
      label: "ZIP",
      description: "User's zip or postal code.",
      optional: true,
    },
    country: {
      type: "string",
      label: "Country",
      description: "User's country.",
      optional: true,
    },
    mobile: {
      type: "string",
      label: "Mobile",
      description: "User's mobile phone.",
      optional: true,
    },
    addPhone: {
      type: "string",
      label: "Add Phone",
      description: "User's phone number 3.",
      optional: true,
    },
    cellCountry: {
      type: "string",
      label: "Cell Country",
      description: "User's mobile phone country code.",
      optional: true,
    },
    handle: {
      type: "string",
      label: "Handle",
      description: "This is the **Display Name** under **My Profile**. [View Support Article](https://support.lightspeedvt.com/knowledge-base/account-details/).",
      optional: true,
    },
    hometown: {
      type: "string",
      label: "Hometown",
      description: "User's hometown.",
      optional: true,
    },
    aboutMe: {
      type: "string",
      label: "About Me",
      description: "A short description about the user.",
      optional: true,
    },
    facebook: {
      type: "string",
      label: "Facebook",
      description: "Facebook username.",
      optional: true,
    },
    linkedIn: {
      type: "string",
      label: "LinkedIn",
      description: "LinkedIn username.",
      optional: true,
    },
    instagram: {
      type: "string",
      label: "Instagram",
      description: "Instagram username.",
      optional: true,
    },
    twitter: {
      type: "string",
      label: "Twitter",
      description: "Twitter handle.",
      optional: true,
    },
    youtube: {
      type: "string",
      label: "Youtube",
      description: "Youtube username.",
      optional: true,
    },
    tikTok: {
      type: "string",
      label: "TikTok",
      description: "TikTok username.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      lightspeedVt,
      grossFeeCharged,
      ...data
    } = this;

    const response = await lightspeedVt.createUser({
      data: {
        ...data,
        grossFeeCharged: grossFeeCharged && parseFloat(grossFeeCharged),
      },
    });
    $.export("$summary", `Successfully created new user with ID ${response.userId}`);
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
LightSpeed VT	`lightspeedVt`	`app`	This component uses the LightSpeed VT app.
Is Active	`isActive`	`boolean`	Set to return active or inactive users only.
Location Id	`locationId`	`string`	Select a value from the drop down menu.
Username	`username`	`string`	The username of the new user.
Password	`password`	`string`	The password for the new user.
Email	`email`	`string`	The email of the new user.
First Name	`firstName`	`string`	The first name of the new user.
Last Name	`lastName`	`string`	The last name of the new user.
Middle Name	`middleName`	`string`	The middle name of the new user.
Title	`title`	`string`	The title of the new user.
Gender	`gender`	`string`	Select a value from the drop down menu:`FemaleMale`
DOB	`dob`	`string`	Valid ISO 8601 timestamp, i.e. yyyyy-MM-ddTHH:mm:ssZ - User's date of birth.
Language	`language`	`string`	Select a value from the drop down menu:`{ "label": "Arabic", "value": "ar" }{ "label": "Arabic (Egyptian)", "value": "ar-eg" }{ "label": "Armenian", "value": "hy-am" }{ "label": "Australian", "value": "en-au" }{ "label": "Bengali", "value": "bn-in" }{ "label": "Bulgarian", "value": "bg-bg" }{ "label": "Chinese", "value": "zh-cn" }{ "label": "Chinese - Hong Kong", "value": "zh-hk" }{ "label": "Chinese (Traditional)", "value": "zh-tw" }{ "label": "Czech Republic", "value": "cs-cz" }{ "label": "Dutch", "value": "nl-nl" }{ "label": "English", "value": "en-us" }{ "label": "English (GB)", "value": "en-gb" }{ "label": "English (NZ)", "value": "en-nz" }{ "label": "English (Queen's)", "value": "en-ca" }{ "label": "English (Southern)", "value": "en-aq" }{ "label": "French", "value": "fr-fr" }{ "label": "French-Canadian", "value": "fr-ca" }{ "label": "German", "value": "de-de" }{ "label": "Haitian (Creole)", "value": "ht-ht" }{ "label": "Hebrew", "value": "he-il" }{ "label": "Hindi", "value": "hi-in" }{ "label": "Italian", "value": "it-it" }{ "label": "Japanese", "value": "ja" }{ "label": "Korean", "value": "ko-kr" }{ "label": "Lithuanian", "value": "lt-lt" }{ "label": "Malay", "value": "ms" }{ "label": "Mongolian", "value": "mn-mn" }{ "label": "Polish", "value": "pl-pl" }{ "label": "Portuguese", "value": "pt-pt" }{ "label": "Portuguese (Brazil)", "value": "pt-br" }{ "label": "Romanian (MD)", "value": "ro-md" }{ "label": "Russian", "value": "ru-ru" }{ "label": "Serbian", "value": "sr-rs" }{ "label": "Slovak", "value": "sk-sk" }{ "label": "Slovenian", "value": "sl-si" }{ "label": "Spanish", "value": "es-es" }{ "label": "Spanish (Col)", "value": "es-co" }{ "label": "Spanish (Ecuador)", "value": "es-ec" }{ "label": "Spanish (Mex)", "value": "es-mx" }{ "label": "Spanish (US)", "value": "es-us" }{ "label": "Swahili", "value": "sw" }{ "label": "Thai", "value": "th-th" }{ "label": "Turkish", "value": "tr-tr" }{ "label": "Vietnamese", "value": "vi-vn" }`
Access Level	`accessLevel`	`integer`	The access level for the new user. See Access Levels Definition
Company Name	`companyName`	`string`	The company of the new user.
Team Id	`teamId`	`string`	Select a value from the drop down menu.
Job Position Id	`jobPositionId`	`string`	Select a value from the drop down menu.
Hire Date	`hireDate`	`string`	Valid ISO 8601 timestamp, i.e. yyyyy-MM-ddTHH:mm:ssZ - User's hiring date.
Start Date	`startDate`	`string`	Valid ISO 8601 timestamp, i.e. yyyyy-MM-ddTHH:mm:ssZ - User's starting date.
Release Date	`releaseDate`	`string`	Valid ISO 8601 timestamp, i.e. yyyyy-MM-ddTHH:mm:ssZ - User's release date.
Expire Date	`expireDate`	`string`	Valid ISO 8601 timestamp, i.e. yyyyy-MM-ddTHH:mm:ssZ - User's account expiration date.
Affiliate Id	`affiliateId`	`string`	Affiliate Id associated with creation of user's account.
Vendor Id	`vendorId`	`string`	Custom vendor Id associated with creation of user's account.
Misc 1	`misc1`	`string`	Miscellaneous info field 1.
Misc 2	`misc2`	`string`	Miscellaneous info field 2.
Phone 1	`phone1`	`string`	User's phone number 1.
Phone 2	`phone2`	`string`	User's phone number 2.
Content Role Id	`contentRole`	`integer[]`	Select a value from the drop down menu.
Lock Username	`lockUsername`	`boolean`	Restricts user from changing its username.
Lock Username Password	`lockUsernamePassword`	`boolean`	Restricts user from changing its username and password.
Force Password Update	`forcePasswordUpdate`	`boolean`	Forces user to update its password upon first sign in.
Update My Profile	`updateMyProfile`	`boolean`	Restricts user from updating its profile.
Manage Users	`manageUsers`	`boolean`	Restricts user from managing other users.
Billing Frequency	`billingFrequency`	`integer`	Use to specify the billing schedule frequency in months. Required if your API settings are set to require this parameter.
Gross Fee Charged	`grossFeeCharged`	`string`	Use to specify the fee per user. Required if your API settings are set to require this parameter.
Promo Code	`promoCode`	`string`	Promo code used during user's account creation.
Address 1	`address1`	`string`	User's address line 1.
Address 2	`address2`	`string`	User's address line 2.
City	`city`	`string`	User's city.
State	`state`	`string`	User's state or province.
ZIP	`zip`	`string`	User's zip or postal code.
Country	`country`	`string`	User's country.
Mobile	`mobile`	`string`	User's mobile phone.
Add Phone	`addPhone`	`string`	User's phone number 3.
Cell Country	`cellCountry`	`string`	User's mobile phone country code.
Handle	`handle`	`string`	This is the Display Name under My Profile. View Support Article.
Hometown	`hometown`	`string`	User's hometown.
About Me	`aboutMe`	`string`	A short description about the user.
Facebook	`facebook`	`string`	Facebook username.
LinkedIn	`linkedIn`	`string`	LinkedIn username.
Instagram	`instagram`	`string`	Instagram username.
Twitter	`twitter`	`string`	Twitter handle.
Youtube	`youtube`	`string`	Youtube username.
TikTok	`tikTok`	`string`	TikTok username.

Action Authentication#

LightSpeed VT uses API keys for authentication. When you connect your LightSpeed VT account, Pipedream securely stores the keys so you can easily authenticate to LightSpeed VT APIs in both code and no-code steps.

To retrieve your API Keys and API Password,