Create Report with Expensify API on New Monitor Run Completed from Postman API

Pipedream makes it easy to connect APIs for Expensify, Postman and 2,900+ other apps remarkably fast.

Trigger workflow on

New Monitor Run Completed from the Postman API

Next, do this

Create Report with the Expensify 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 Postman trigger and Expensify action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Monitor Run Completed trigger
1. Connect your Postman account
2. Configure timer
3. Select a Monitor ID
Configure the Create Report action
1. Connect your Expensify account
2. Configure Employee Email
3. Select a Policy ID
4. Configure Report Title
5. Configure Expenses
6. Optional- Configure Report Fields
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 Monitor Run Completed on Postman

Description:Emit new event when a monitor run is completed. [See the documentation](https://learning.postman.com/docs/monitoring-your-api/intro-monitors/)

Version:0.0.1

Key:postman-monitor-run-completed

View on GitHub

Postman Overview#

The Postman API enables you to automate tasks within your Postman collections, such as running collections, fetching and updating environments, and integrating your API development workflow into your CI/CD pipeline. Using Pipedream, you can harness this functionality to create custom workflows that trigger on various events, process data, and connect with other apps, extending the capabilities of your API testing and development processes.

Trigger Code#

import postman from "../../postman.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "postman-monitor-run-completed",
  name: "New Monitor Run Completed",
  description: "Emit new event when a monitor run is completed. [See the documentation](https://learning.postman.com/docs/monitoring-your-api/intro-monitors/)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    postman,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: 60,
      },
    },
    monitorId: {
      propDefinition: [
        postman,
        "monitorId",
      ],
    },
  },
  methods: {
    _getLastDate() {
      return this.db.get("lastDate") || new Date("1970-01-01");
    },
    _setLastDate(lastDate) {
      this.db.set("lastDate", lastDate);
    },
    async startEvent() {
      const lastDate = this._getLastDate();

      const { monitor } = await this.postman.getMonitor({
        monitorId: this.monitorId,
      });

      if (monitor.lastRun?.status === "success" && new Date(monitor.lastRun.startedAt) > new Date(lastDate)) {
        this._setLastDate(monitor.lastRun.startedAt);
        this.emitEvent(monitor);
      }
    },
    emitEvent(monitor) {
      this.$emit(monitor, {
        id: monitor.id + monitor.lastRun.startedAt,
        summary: `Monitor Run Completed: ${monitor.name}`,
        ts: Date.parse(monitor.lastRun.finishedAt),
      });
    },
  },
  async run() {
    await this.startEvent();
  },
  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
Postman	`postman`	`app`	This component uses the Postman app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Monitor ID	`monitorId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

To retrieve your API key,

Navigate to your Postman account and sign in
Go to your Integration Dashboard
Click "Generate API Key", and copy and paste it below.

About Postman#

Postman is the world's leading API platform.

Action#

Create Report on Expensify

Description:Creates a new report with transactions in a user's account. [See docs here](https://integrations.expensify.com/Integration-Server/doc/#report-creator)

Version:0.0.3

Key:expensify-create-report

View on GitHub

Expensify Overview#

The Expensify API enables the automation of expense reporting and management tasks. By harnessing this API within Pipedream, you can craft workflows that streamline the expense submission process, synchronize financial data across platforms, and trigger actions based on expense report statuses. With Pipedream’s serverless platform, these automations can run in the background, allowing for real-time data processing and interaction between Expensify and a myriad of other apps and services.

Action Code#

import { defineAction } from "@pipedream/types";
import app from "../../app/expensify.app.mjs";
import utils from "../../common/utils.mjs";
export default defineAction({
    key: "expensify-create-report",
    version: "0.0.3",
    annotations: {
        destructiveHint: false,
        openWorldHint: true,
        readOnlyHint: false,
    },
    name: "Create Report",
    description: "Creates a new report with transactions in a user's account. [See docs here](https://integrations.expensify.com/Integration-Server/doc/#report-creator)",
    type: "action",
    props: {
        app,
        employeeEmail: {
            description: "The report will be created in this account.",
            propDefinition: [
                app,
                "employeeEmail",
            ],
        },
        policyId: {
            propDefinition: [
                app,
                "policyId",
                ({ employeeEmail }) => ({
                    userEmail: employeeEmail,
                }),
            ],
        },
        reportTitle: {
            label: "Report Title",
            description: "The title of the report that will be created.",
            type: "string",
        },
        expenses: {
            type: "string[]",
            label: "Expenses",
            description: `Array of expense objects to include in the report. Each expense should be a JSON object with the following required fields:

- \`date\`: The date the expense was made (format yyyy-mm-dd)
- \`currency\`: Three-letter currency code (e.g., "USD", "EUR", "CAD")
- \`merchant\`: The name of the merchant
- \`amount\`: The amount in cents (e.g., 2500 for $25.00)

**Example:**
\`\`\`json
[
  {
    "date": "2024-01-15",
    "currency": "USD", 
    "merchant": "Hotel ABC",
    "amount": 15000
  },
  {
    "date": "2024-01-16",
    "currency": "USD",
    "merchant": "Restaurant XYZ", 
    "amount": 5000
  }
]
\`\`\``,
        },
        reportFields: {
            type: "object",
            label: "Report Fields",
            description: `Custom fields for the report as a JSON object. Use this to set values for custom report fields in your Expensify policy.

- \`Key format\`: Field names should have all non-alphanumerical characters replaced with underscores (_)
- \`Value format\`: String values for the corresponding field

**Example:**
\`\`\`json
{
  "reason_of_trip": "Business meetings with clients",
  "employees": "3",
  "department": "Sales",
  "project_code": "PROJ_2024_001"
}
\`\`\``,
            optional: true,
        },
    },
    async run({ $ }) {
        const { policyId, employeeEmail, reportTitle, reportFields, expenses, } = this;
        const response = await this.app.createReport({
            $,
            data: {
                employeeEmail,
                policyID: policyId,
                report: {
                    title: reportTitle,
                    ...(reportFields && {
                        fields: utils.parseJson(reportFields),
                    }),
                },
                expenses: utils.parseArray(expenses),
            },
        });
        $.export("$summary", `Successfully created report \`${response.reportName}\` with ID \`${response.reportID}\``);
        return response;
    },
});

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
Expensify	`app`	`app`	This component uses the Expensify app.
Employee Email	`employeeEmail`	`string`	The report will be created in this account.
Policy ID	`policyId`	`string`	Select a value from the drop down menu.
Report Title	`reportTitle`	`string`	The title of the report that will be created.
Expenses	`expenses`	`string[]`	Array of expense objects to include in the report. Each expense should be a JSON object with the following required fields: `date`: The date the expense was made (format yyyy-mm-dd) `currency`: Three-letter currency code (e.g., "USD", "EUR", "CAD") `merchant`: The name of the merchant `amount`: The amount in cents (e.g., 2500 for $25.00) Example: `[ { "date": "2024-01-15", "currency": "USD", "merchant": "Hotel ABC", "amount": 15000 }, { "date": "2024-01-16", "currency": "USD", "merchant": "Restaurant XYZ", "amount": 5000 } ]`
Report Fields	`reportFields`	`object`	Custom fields for the report as a JSON object. Use this to set values for custom report fields in your Expensify policy. `Key format`: Field names should have all non-alphanumerical characters replaced with underscores (_) `Value format`: String values for the corresponding field Example: `{ "reason_of_trip": "Business meetings with clients", "employees": "3", "department": "Sales", "project_code": "PROJ_2024_001" }`