Add or update multiple records with Data Stores API on New Job Created from Tidy API

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

Trigger workflow on

New Job Created from the Tidy API

Next, do this

Add or update multiple records 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 Tidy 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 Job Created trigger
1. Connect your Tidy account
2. Configure timer
3. Optional- Select a Address
4. Optional- Select one or more Status
Configure the Add or update multiple records action
1. Connect your Data Stores account
2. Configure Data Store
3. Configure Data
4. Optional- Configure Time to Live (TTL)
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 Job Created on Tidy

Description:Emit new event when a new job is created in Tidy

Version:0.0.1

Key:tidy-new-job-created

View on GitHub

Tidy Overview#

The Tidy API offers a range of functions tailored for property management, enabling users to automate tasks like booking cleanings, managing properties, and keeping track of services. Integrating the Tidy API into Pipedream workflows opens up possibilities for automating communications, scheduling, and property management tasks by connecting Tidy with hundreds of other apps. This can significantly streamline operations for property managers, cleaning services, and real estate businesses.

Trigger Code#

import common from "../common/common.mjs";
import constants from "../../common/constants.mjs";

export default {
  ...common,
  key: "tidy-new-job-created",
  name: "New Job Created",
  description: "Emit new event when a new job is created in Tidy",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    addressId: {
      propDefinition: [
        common.props.tidy,
        "addressId",
      ],
    },
    status: {
      type: "string[]",
      label: "Status",
      description: "Filter jobs by status or statuses",
      options: constants.JOB_STATUS,
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    async getItems() {
      const { data } = await this.tidy.listJobs({
        params: {
          address_id: this.addressId,
          status: this.status?.length
            ? (this.status).join()
            : undefined,
        },
      });
      return data;
    },
    generateMeta(job) {
      return {
        id: job.id,
        summary: `New Job ID ${job.id}`,
        ts: Date.parse(job.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
Tidy	`tidy`	`app`	This component uses the Tidy app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Address	`addressId`	`string`	Select a value from the drop down menu.
Status	`status`	`string[]`	Select a value from the drop down menu:`scheduledin_progresscompletedcancelledfailed`

Trigger Authentication#

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

To retrieve your API Key,

Navigate to your Tidy account and sign in
Go to “More” > “Developers” > “API Keys”

About Tidy#

TIDY helps to maintain a clean house. A rental. Your employee's workspace. Your home. All automated through TIDY.

Action#

Add or update multiple records on Data Stores

Description:Add or update multiple records to your [Pipedream Data Store](https://pipedream.com/data-stores/).

Version:0.0.8

Key:data_stores-add-update-multiple-records

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-add-update-multiple-records",
  name: "Add or update multiple records",
  description: "Add or update multiple records to your [Pipedream Data Store](https://pipedream.com/data-stores/).",
  version: "0.0.8",
  annotations: {
    destructiveHint: true,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    app,
    dataStore: {
      propDefinition: [
        app,
        "dataStore",
      ],
    },
    data: {
      label: "Data",
      type: "object",
      description: "Enter data you'd like to add as key-value pairs, or reference an object from a previous step using a custom expression (e.g., `{{steps.data.$return_value}}`). Note that any keys that are duplicated will get overwritten with the last value entered (so `[{jerry: \"constanza\", jerry: \"seinfeld\"}]` will get stored as `[{jerry: \"seinfeld\"}]`).",
    },
    ttl: {
      propDefinition: [
        app,
        "ttl",
      ],
    },
  },
  methods: {
    /**
     * Tries to convert a string to a JSON object or a primitive value.
     * @param {any} value Value to be converted
     * @returns The converted value
     */
    convertString(value) {
      // If type is already primitive non string, return it
      const primitives = [
        "boolean",
        "number",
      ];
      if (primitives.includes(typeof value)) {
        return value;
      }

      // Tries to convert string to possible other primitive types
      if (typeof value === "string") {
        // Convert boolean
        if (value.toLowerCase() === "true") {
          return true;
        }
        if (value.toLowerCase() === "false") {
          return false;
        }

        // Convert number
        if (!isNaN(value)) {
          return parseFloat(value);
        }
      }

      return this.app.evaluate(value);
    },
    /**
     * Add all the key-value pairs in the map object to be used in the data store
     * @param {*} data Data to be parsed
     * @param {Map} map Hashmap to be updated
     */
    populateHashMapOfData(data, map) {
      if (!Array.isArray(data) && typeof(data) === "object") {
        Object.keys(data).forEach((key) => map[key] = this.convertString(data[key]));
        return;
      }

      if (Array.isArray(data)) {
        for (const item of data) {
          this.populateHashMapOfData(item, map);
        }
      }
    },
    getHashMapOfData(data) {
      const map = {};
      this.populateHashMapOfData(data, map);
      return map;
    },
  },
  async run({ $ }) {
    if (typeof this.data === "string") {
      this.data = this.app.evaluate(this.data);
    }
    const map = this.getHashMapOfData(this.data);
    const keys = Object.keys(map);

    const promises = Object.keys(map).map((key) => {
      if (this.ttl) {
        return this.dataStore.set(key, map[key], {
          ttl: this.ttl,
        });
      } else {
        return this.dataStore.set(key, map[key]);
      }
    });

    await Promise.all(promises);

    if (keys.length === 0) {
      $.export("$summary", "No data was added to the data store.");
    } else {
      // eslint-disable-next-line multiline-ternary
      $.export("$summary", `Successfully added or updated ${keys.length} record${keys.length === 1 ? "" : "s"}${this.ttl ? ` (expires in ${this.app.formatTtl(this.ttl)})` : ""}`);
    }

    // Include TTL in the returned map
    return {
      ...map,
      _ttl: this.ttl || null,
    };
  },
};

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.
Data	`data`	`object`	Enter data you'd like to add as key-value pairs, or reference an object from a previous step using a custom expression (e.g., `{{steps.data.$return_value}}`). Note that any keys that are duplicated will get overwritten with the last value entered (so `[{jerry: "constanza", jerry: "seinfeld"}]` will get stored as `[{jerry: "seinfeld"}]`).
Time to Live (TTL)	`ttl`	`integer`	The number of seconds until this record expires and is automatically deleted. Examples: 3600 (1 hour), 86400 (1 day), 604800 (1 week). Leave blank for records that should not expire.