Check for existence of key with Data Stores API on New Session from LiveSession API

Pipedream makes it easy to connect APIs for Data Stores, LiveSession and 2,400+ other apps remarkably fast.

Trigger workflow on

New Session from the LiveSession API

Next, do this

Check for existence of key with the Data Stores 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 LiveSession trigger and Data Stores action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Session trigger
1. Connect your LiveSession account
2. Configure timer
3. Optional- Configure Email
Configure the Check for existence of key action
1. Connect your Data Stores account
2. Configure Data Store
3. Select a Key
4. Optional- Select a Create a new record if the key is not found?
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 Session on LiveSession

Description:Emit new event when a new session is created in LiveSession. [See the documentation](https://developers.livesession.io/rest-api/reference#list-sessions)

Version:0.0.1

Key:livesession-new-session

View on GitHub

LiveSession Overview#

LiveSession is an app that allows you to understand user behavior through session replays and analytics. With its API, you can retrieve session data, manage users, and more. Integrating LiveSession with Pipedream lets you automate actions based on user interactions, compile analytics, or trigger workflows in other apps based on session insights. This can be immensely valuable for support teams, product managers, and UX designers seeking to improve user experience.

Trigger Code#

import livesession from "../../livesession.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  key: "livesession-new-session",
  name: "New Session",
  description: "Emit new event when a new session is created in LiveSession. [See the documentation](https://developers.livesession.io/rest-api/reference#list-sessions)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    livesession,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    email: {
      type: "string",
      label: "Email",
      description: "Filter events by the email address that you have associated with a session",
      optional: true,
    },
  },
  hooks: {
    async deploy() {
      await this.processEvent(25);
    },
  },
  methods: {
    _getLastCreated() {
      return this.db.get("lastCreated") || 0;
    },
    _setLastCreated(lastCreated) {
      this.db.set("lastCreated", lastCreated);
    },
    generateMeta(session) {
      return {
        id: session.id,
        summary: `New Session ID ${session.id}`,
        ts: session.creation_timestamp,
      };
    },
    async processEvent(max) {
      const lastCreated = this._getLastCreated();
      let maxCreated = lastCreated;
      const params = {
        date_from: new Date(lastCreated),
        email: this.email,
      };
      const items = this.livesession.paginate({
        resourceFn: this.livesession.listSessions,
        params,
        resourceType: "sessions",
        max,
      });
      for await (const item of items) {
        if (item.creation_timestamp > lastCreated) {
          const meta = this.generateMeta(item);
          this.$emit(item, meta);
          if (item.creation_timestamp > maxCreated) {
            maxCreated = item.creation_timestamp;
          }
        }
      }
      this._setLastCreated(maxCreated);
    },
  },
  async run() {
    await this.processEvent();
  },
};

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
LiveSession	`livesession`	`app`	This component uses the LiveSession app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Email	`email`	`string`	Filter events by the email address that you have associated with a session

Trigger Authentication#

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

About LiveSession#

The fastest way to analyze and optimize customer experience.

Action#

Check for existence of key on Data Stores

Description:Check if a key exists in your [Pipedream Data Store](https://pipedream.com/data-stores/) or create one if it doesn't exist.

Version:0.1.2

Key:data_stores-has-key-or-create

View on GitHub

Data Stores Overview#

Data Stores are a key-value store that allow you to persist state and share data across workflows. You can perform CRUD operations, enabling dynamic data management within your serverless architecture. Use it to save results from API calls, user inputs, or interim data; then read, update, or enrich this data in subsequent steps or workflows. Data Stores simplify stateful logic and cross-workflow communication, making them ideal for tracking process statuses, aggregating metrics, or serving as a simple configuration store.

Action Code#

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

export default {
  key: "data_stores-has-key-or-create",
  name: "Check for existence of key",
  description: "Check if a key exists in your [Pipedream Data Store](https://pipedream.com/data-stores/) or create one if it doesn't exist.",
  version: "0.1.2",
  type: "action",
  props: {
    app,
    dataStore: {
      propDefinition: [
        app,
        "dataStore",
      ],
    },
    key: {
      propDefinition: [
        app,
        "key",
        ({ dataStore }) => ({
          dataStore,
        }),
      ],
      description: "Enter the key you'd like to check.",
    },
    addRecordIfNotFound: {
      propDefinition: [
        app,
        "addRecordIfNotFound",
      ],
    },
  },
  async additionalProps() {
    const props = {};
    if (this.app.shouldAddRecord(this.addRecordIfNotFound)) {
      props.value = app.propDefinitions.value;
    }
    return props;
  },
  async run({ $ }) {
    if (await this.dataStore.has(this.key)) {
      $.export("$summary", `Key \`${this.key}\` exists.`);

      return {
        existingKeyFound: true,
        newKeyCreated: false,
      };
    }

    if (!this.app.shouldAddRecord(this.addRecordIfNotFound)) {
      $.export("$summary", `Key \`${this.key}\` does not exist.`);

      return {
        existingKeyFound: false,
        newKeyCreated: false,
      };
    }

    const parsedValue = this.app.parseValue(this.value);
    await this.dataStore.set(this.key, parsedValue);
    $.export("$summary", `Key \`${this.key}\` was not found. Successfully added a new record.`);

    return {
      existingKeyFound: false,
      newKeyCreated: true,
      value: parsedValue,
    };
  },
};

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
Data Stores	`app`	`app`	This component uses the Data Stores app.
Data Store	`dataStore`	`data_store`	Select an existing Data Store or create a new one.
Key	`key`	`string`	Select a value from the drop down menu.
Create a new record if the key is not found?	`addRecordIfNotFound`	`string`	Select a value from the drop down menu:`YesNo`