Append to record with Data Stores API on New Document Parsed from Airparser API

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

Trigger workflow on

New Document Parsed from the Airparser API

Next, do this

Append to record 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 Airparser 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 Document Parsed trigger
1. Connect your Airparser account
2. Configure timer
3. Select a Inbox ID
Configure the Append to record action
1. Connect your Data Stores account
2. Configure Data Store
3. Select a Key
4. Configure Value
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 Document Parsed on Airparser

Description:Emit new event when a document is parsed. [See the documentation](https://help.airparser.com/public-api/public-api)

Version:0.0.1

Key:airparser-new-document-parsed

View on GitHub

Airparser Overview#

The Airparser API simplifies the process of extracting data from emails, such as order confirmations, shipping notifications, or any structured email content. By transforming emails into structured data, it enables seamless integration of email data into various workflows. On Pipedream, you can leverage this API to create automations that act on the parsed data—like updating databases, triggering notifications, or integrating with other apps and services.

Trigger Code#

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

export default {
  key: "airparser-new-document-parsed",
  name: "New Document Parsed",
  description: "Emit new event when a document is parsed. [See the documentation](https://help.airparser.com/public-api/public-api)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    airparser,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    inboxId: {
      propDefinition: [
        airparser,
        "inboxId",
      ],
    },
  },
  hooks: {
    async deploy() {
      await this.processEvent(25);
    },
  },
  methods: {
    generateMeta(doc) {
      const ts = Date.parse(doc.processed_at);
      return {
        id: `${doc._id}${ts}`,
        summary: `New Document ${doc.name}`,
        ts,
      };
    },
    async processEvent(max) {
      const items = this.airparser.paginate({
        resourceFn: this.airparser.listDocuments,
        args: {
          inboxId: this.inboxId,
          params: {
            statuses: [
              "parsed",
            ],
          },
        },
        resourceType: "docs",
        max,
      });

      for await (const item of items) {
        const meta = this.generateMeta(item);
        this.$emit(item, meta);
      }
    },
  },
  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
Airparser	`airparser`	`app`	This component uses the Airparser app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Inbox ID	`inboxId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

About Airparser#

Revolutionize data extraction with the GPT-powered document parser.

Action#

Append to record on Data Stores

Description:Append to a record in your data store [Pipedream Data Store](https://pipedream.com/data-stores/). If the record does not exist, a new record will be created in an array format.

Version:0.0.2

Key:data_stores-append-to-record

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 { ConfigurationError } from "@pipedream/platform";
import app from "../../data_stores.app.mjs";

export default {
  key: "data_stores-append-to-record",
  name: "Append to record",
  description: "Append to a record in your data store [Pipedream Data Store](https://pipedream.com/data-stores/). If the record does not exist, a new record will be created in an array format.",
  version: "0.0.2",
  type: "action",
  props: {
    app,
    dataStore: {
      propDefinition: [
        app,
        "dataStore",
      ],
    },
    key: {
      propDefinition: [
        app,
        "key",
        ({ dataStore }) => ({
          dataStore,
        }),
      ],
      description: "Enter a key for the record set you'd like to append to. Refer to your existing keys [here](https://pipedream.com/data-stores/).",
    },
    value: {
      propDefinition: [
        app,
        "value",
      ],
    },
  },
  async run({ $ }) {
    const {
      key,
      value,
    } = this;
    const currentValue = await this.dataStore.get(key);
    if (currentValue && !Array.isArray(currentValue)) {
      throw new ConfigurationError("The value for the specified key is not an array. You can only append records to an array.");
    }
    const recordSet = currentValue ?? [];
    const parsedValue = this.app.parseValue(value);
    recordSet.push(parsedValue);
    await this.dataStore.set(key, recordSet);
    // eslint-disable-next-line multiline-ternary
    $.export("$summary", `Successfully ${currentValue ? "appended to the record for" : "created new record with the"} key: \`${key}\`.`);
    return {
      key,
      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.
Value	`value`	`any`	Enter a string, object, or array.