Create Member with Freshlearn API on New Test Run from TestLocally API

Pipedream makes it easy to connect APIs for Freshlearn, TestLocally and 2,700+ other apps remarkably fast.

Trigger workflow on

New Test Run from the TestLocally API

Next, do this

Create Member with the Freshlearn 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 TestLocally trigger and Freshlearn action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Test Run trigger
1. Connect your TestLocally account
2. Configure timer
3. Optional- Configure Owners
4. Optional- Configure Locations
5. Optional- Configure Target
6. Optional- Configure Scheduled
7. Optional- Select a Browser
8. Optional- Select a Viewport
Configure the Create Member action
1. Connect your Freshlearn account
2. Configure Email
3. Configure Full Name
4. Configure Source
5. Optional- Configure Phone
6. Optional- Configure City
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#

New Test Run on TestLocally

Description:Emit new event when a new test is run or completed in TestLocally. [See the documentation](https://testlocally.readme.io/reference/api_v0_recent_tests)

Version:0.0.1

Key:testlocally-new-test-run

View on GitHub

Trigger Code#

import testlocally from "../../testlocally.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import { parseObject } from "../../common/utils.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "testlocally-new-test-run",
  name: "New Test Run",
  description: "Emit new event when a new test is run or completed in TestLocally. [See the documentation](https://testlocally.readme.io/reference/api_v0_recent_tests)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    testlocally,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    owners: {
      propDefinition: [
        testlocally,
        "owners",
      ],
    },
    locations: {
      propDefinition: [
        testlocally,
        "locations",
      ],
    },
    target: {
      propDefinition: [
        testlocally,
        "target",
      ],
    },
    scheduled: {
      propDefinition: [
        testlocally,
        "scheduled",
      ],
    },
    browser: {
      propDefinition: [
        testlocally,
        "browser",
      ],
    },
    viewport: {
      propDefinition: [
        testlocally,
        "viewport",
      ],
    },
  },
  methods: {
    _getLastTs() {
      return this.db.get("lastTs") || 0;
    },
    _setLastTs(ts) {
      this.db.set("lastTs", ts);
    },
    generateMeta(test) {
      return {
        id: test.id,
        summary: `New Test Run ID: ${test.id}`,
        ts: test.created,
      };
    },
    async processEvent(max) {
      const lastTs = this._getLastTs();
      const results = this.testlocally.paginate({
        fn: this.testlocally.listTests,
        args: {
          params: {
            owners: parseObject(this.owners),
            locations: parseObject(this.locations),
            target: this.target,
            scheduled: this.scheduled,
            browser: this.browser,
            viewport: this.viewport,
          },
        },
        max,
      });

      const tests = [];
      for await (const test of results) {
        if (test.created > lastTs) {
          tests.push(test);
        } else {
          break;
        }
      }

      if (!tests.length) {
        return;
      }

      this._setLastTs(tests[0].created);

      tests.reverse().forEach((test) => {
        const meta = this.generateMeta(test);
        this.$emit(test, meta);
      });
    },
  },
  hooks: {
    async deploy() {
      await this.processEvent(25);
    },
  },
  async run() {
    await this.processEvent();
  },
  sampleEmit,
};

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
TestLocally	`testlocally`	`app`	This component uses the TestLocally app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Owners	`owners`	`string[]`	A list of userIds of the owners of the tests to retrieve
Locations	`locations`	`string[]`	A list of locations of the tests to retrieve
Target	`target`	`string`	The target URL of the tests to retrieve
Scheduled	`scheduled`	`string`	The scheduled status of the tests to retrieve. Values: 'yes', 'no', or a specific schedule ID
Browser	`browser`	`string`	Select a value from the drop down menu:`chromiumchromefirefoxmsedgewebkit`
Viewport	`viewport`	`string`	Select a value from the drop down menu:`desktoptabletphone`

Trigger Authentication#

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

About TestLocally#

See what your website looks like from anywhere

Action#

Create Member on Freshlearn

Description:Creates a new member within FreshLearn. [See the documentation](https://freshlearn.com/support/api#createMember)

Version:0.0.1

Key:freshlearn-create-member

View on GitHub

Freshlearn Overview#

The Freshlearn API provides a gateway to interact with Freshlearn's learning management system, allowing for the automation of course creation, user management, and analytics retrieval. By leveraging this API within Pipedream, you can create powerful serverless workflows that integrate Freshlearn with other apps to enhance the educational experience, streamline administrative tasks, and analyze course performance.

Action Code#

import freshlearn from "../../freshlearn.app.mjs";

export default {
  key: "freshlearn-create-member",
  name: "Create Member",
  description: "Creates a new member within FreshLearn. [See the documentation](https://freshlearn.com/support/api#createMember)",
  version: "0.0.1",
  type: "action",
  props: {
    freshlearn,
    email: {
      propDefinition: [
        freshlearn,
        "email",
      ],
    },
    fullName: {
      propDefinition: [
        freshlearn,
        "fullName",
      ],
    },
    source: {
      propDefinition: [
        freshlearn,
        "source",
      ],
    },
    phone: {
      propDefinition: [
        freshlearn,
        "phone",
      ],
      optional: true,
    },
    city: {
      propDefinition: [
        freshlearn,
        "city",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.freshlearn.createMember({
      data: {
        email: this.email,
        fullName: this.fullName,
        source: this.source,
        phone: this.phone,
        city: this.city,
      },
      $,
    });

    if (response?.id) {
      $.export("$summary", `Successfully created new member with ID ${response.id}.`);
    }

    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
Freshlearn	`freshlearn`	`app`	This component uses the Freshlearn app.
Email	`email`	`string`	The email address of the member
Full Name	`fullName`	`string`	The full name of the member
Source	`source`	`string`	Zapier/FreshLearn/etc
Phone	`phone`	`string`	The phone number of the member
City	`city`	`string`	The city of the member

Action Authentication#

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

To retrieve your API key,