Get all records with Data Stores API on New Expense from Oyster API

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

Trigger workflow on

New Expense from the Oyster API

Next, do this

Get all 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 Oyster 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 Expense trigger
1. Connect your Oyster account
2. Configure timer
Configure the Get all records action
1. Connect your Data Stores account
2. Configure Data Store
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 Expense on Oyster

Description:Emit new event when a new expense is created in Oyster. [See the documentation](https://docs.oysterhr.com/reference/get_v1-expenses)

Version:0.0.1

Key:oyster-new-expense

View on GitHub

Oyster Overview#

The Oyster API allows you to streamline your global employment processes by providing programmatic access to their HR platform. With it, you can automate tasks like managing employee details, handling payroll, and tracking time off. Pipedream, as a serverless integration platform, makes it simple to create workflows that connect the Oyster API with hundreds of other apps. This can help in automating HR operations, syncing employee data across systems, or even sending notifications when certain HR events occur.

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "oyster-new-expense",
  name: "New Expense",
  description: "Emit new event when a new expense is created in Oyster. [See the documentation](https://docs.oysterhr.com/reference/get_v1-expenses)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getTsField() {
      return "submittedAt";
    },
    getResourceFn() {
      return this.oyster.listExpenses;
    },
    generateMeta(expense) {
      return {
        id: expense.expenseId,
        summary: `New Expense ${expense.expenseId}`,
        ts: Date.parse(expense.submittedAt),
      };
    },
  },
  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
Oyster	`oyster`	`app`	This component uses the Oyster app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

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

About Oyster#

Automated Global Employment Platform

Action#

Get all records on Data Stores

Description:Get all records in your [Pipedream Data Store](https://pipedream.com/data-stores/). The memory consumption of the workflow can be affected, since this action will be exposing, to the workflow, the entire data from the selected datastore.

Version:0.0.3

Key:data_stores-get-all-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-get-all-records",
  name: "Get all records",
  description: "Get all records in your [Pipedream Data Store](https://pipedream.com/data-stores/). The memory consumption of the workflow can be affected, since this action will be exposing, to the workflow, the entire data from the selected datastore.",
  version: "0.0.3",
  type: "action",
  props: {
    app,
    dataStore: {
      propDefinition: [
        app,
        "dataStore",
      ],
    },
  },
  async run({ $ }) {
    const objData = {};
    let count = 0;
    for await (const [
      k,
      v,
    ] of this.dataStore) {
      objData[k] = v;
      count++;
    }
    $.export("$summary", `Successfully returned ${count} keys.`);
    return objData;
  },
};