Send Yourself an Email with Email API on New Transaction from BoxHero API

Pipedream makes it easy to connect APIs for Email, BoxHero and 2,400+ other apps remarkably fast.

Trigger workflow on

New Transaction from the BoxHero API

Next, do this

Send Yourself an Email with the Email 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 BoxHero trigger and Email action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Transaction trigger
1. Connect your BoxHero account
2. Configure timer
3. Optional- Select a Transaction Type
Configure the Send Yourself an Email action
1. Connect your Email account
2. Configure subject
3. Configure text
4. Optional- Configure HTML
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 Transaction on BoxHero

Description:Emit new event when a transaction occurs. [See the documentation](https://docs-en.boxhero-app.com/integrations-and-api/boxhero-api-reference#v1-txs)

Version:0.0.1

Key:boxhero-new-transaction

View on GitHub

BoxHero Overview#

The BoxHero API provides tools to manage inventory in a streamlined and efficient way. By integrating with Pipedream, you can automate inventory tracking, update stock levels in real-time, and synchronize data across platforms. Create powerful workflows that trigger actions based on inventory changes, connect to other apps for a seamless operation, or analyze inventory data for smarter decision-making.

Trigger Code#

import boxhero from "../../boxhero.app.mjs";
import constants from "../../common/constants.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import sampleEmit from "./test-event.mjs";

export default {
  key: "boxhero-new-transaction",
  name: "New Transaction",
  description: "Emit new event when a transaction occurs. [See the documentation](https://docs-en.boxhero-app.com/integrations-and-api/boxhero-api-reference#v1-txs)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    boxhero,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    transactionType: {
      type: "string",
      label: "Transaction Type",
      description: "Filter events by transaction type",
      options: constants.TRANSACTION_TYPE,
      optional: true,
    },
  },
  hooks: {
    async deploy() {
      await this.processEvent(25);
    },
  },
  methods: {
    _getLastCreatedTs() {
      return this.db.get("lastCreatedTs") || 0;
    },
    _setLastCreatedTs(lastCreatedTs) {
      this.db.set("lastCreatedTs", lastCreatedTs);
    },
    emitEvent(transaction) {
      const meta = this.generateMeta(transaction);
      this.$emit(transaction, meta);
    },
    generateMeta(transaction) {
      return {
        id: transaction.id,
        summary: `New Transaction ${transaction.id}`,
        ts: Date.parse(transaction.created_at),
      };
    },
    async getTeamMode() {
      const { mode } = await this.boxhero.getTeam();
      return mode;
    },
    async processEvent(max) {
      const lastCreatedTs = this._getLastCreatedTs();
      let maxTs = lastCreatedTs;

      const teamMode = await this.getTeamMode();
      const resourceFn = teamMode === 0
        ? this.boxhero.listBasicTransactions
        : this.boxhero.listLocationTransactions;

      const results = this.boxhero.paginate({
        resourceFn,
        params: this.transactionType
          ? {
            type: this.transactionType,
          }
          : {},
        max,
      });

      const transactions = [];
      for await (const transaction of results) {
        const ts = Date.parse(transaction.created_at);
        if (ts > lastCreatedTs) {
          transactions.push(transaction);
          if (ts > maxTs) {
            maxTs = ts;
          }
        }
      }

      transactions.reverse().forEach((transaction) => this.emitEvent(transaction));

      this._setLastCreatedTs(maxTs);
    },
  },
  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
BoxHero	`boxhero`	`app`	This component uses the BoxHero app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Transaction Type	`transactionType`	`string`	Select a value from the drop down menu:`{ "value": "in", "label": "Stock In" }{ "value": "out", "label": "Stock Out" }{ "value": "adjust", "label": "Adjust" }{ "value": "move", "label": "Move (exclusive to Location Mode)" }`

Version:0.4.4

Key:email-send-email-to-self

View on GitHub

Action Code#

// legacy_hash_id: a_vgi84r
import email from "../../email.app.mjs";

export default {
  key: "email-send-email-to-self",
  name: "Send Yourself an Email",
  description: "Customize and send an email to the email address you registered with Pipedream. The email will be sent by notifications@pipedream.com.",
  version: "0.4.4",
  type: "action",
  props: {
    email,
    subject: {
      type: "string",
    },
    text: {
      type: "string",
    },
    html: {
      type: "string",
      label: "HTML",
      optional: true,
    },
    // include_collaborators: {
    //   type: "boolean",
    //   optional: true,
    // },
  },
  async run({ $ }) {
    const options = {
      subject: this.subject,
      text: this.text,
    };
    if (this.html) {
      options.html = this.html;
    }
    // if (this.include_collaborators) {
    //   options.include_collaborators = this.include_collaborators;
    // }
    $.send.email(options);
    $.export("$summary", "Successfully sent email");
  },
};