Formatting - [Data] Convert JSON to String with Pipedream Utils API on New Mobile Event from OptimoRoute API

Pipedream makes it easy to connect APIs for Pipedream Utils, OptimoRoute and 3,000+ other apps remarkably fast.

Trigger workflow on

New Mobile Event from the OptimoRoute API

Next, do this

Formatting - [Data] Convert JSON to String with the Pipedream Utils 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 OptimoRoute trigger and Pipedream Utils action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Mobile Event trigger
1. Connect your OptimoRoute account
2. Configure timer
Configure the Formatting - [Data] Convert JSON to String action
1. Connect your Pipedream Utils account
2. Configure Input
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 Mobile Event on OptimoRoute

Description:Emit new event when a new mobile event is received. [See the documentation](https://optimoroute.com/api/#get-mobile-events)

Version:0.0.1

Key:optimoroute-new-mobile-event

View on GitHub

OptimoRoute Overview#

The OptimoRoute API offers a range of functionalities for route optimization and workforce management. By tapping into this API via Pipedream, you can automate complex logistics and delivery operations, scheduling, and real-time order tracking. Leverage the power of serverless workflows to integrate OptimoRoute with other apps, streamlining your dispatch, improving delivery times, and maximizing efficiency. Whether you're planning routes for a fleet of vehicles or scheduling service appointments, the OptimoRoute API provides the data you need to make decisions on-the-fly.

Trigger Code#

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

export default {
  key: "optimoroute-new-mobile-event",
  name: "New Mobile Event",
  description: "Emit new event when a new mobile event is received. [See the documentation](https://optimoroute.com/api/#get-mobile-events)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    optimoroute,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  methods: {
    _getAfterTag() {
      return this.db.get("afterTag");
    },
    _setAfterTag(afterTag) {
      this.db.set("afterTag", afterTag);
    },
    generateMeta(event) {
      return {
        id: event.unixTimestamp,
        summary: `New mobile event for order number: ${event.orderNo}`,
        ts: event.unixTimestamp,
      };
    },
    async *paginateEvents(afterTag) {
      let hasMore;
      do {
        const {
          events = [], tag, remainingEvents,
        } = await this.optimoroute.getMobileEvents({
          params: {
            after_tag: afterTag,
          },
        });
        for (const event of events) {
          yield event;
        }
        afterTag = tag;
        hasMore = remainingEvents > 0;
        if (!hasMore && afterTag?.length) {
          this._setAfterTag(afterTag);
        }
      } while (hasMore);
    },
    async processEvents(limit) {
      const afterTag = this._getAfterTag();
      let events = [];
      const results = this.paginateEvents(afterTag);
      for await (const event of results) {
        events.push(event);
      }
      if (limit) {
        events = events.slice(-1 * limit);
      }
      events.forEach((event) => {
        const meta = this.generateMeta(event);
        this.$emit(event, meta);
      });
    },
  },
  hooks: {
    async deploy() {
      await this.processEvents(10);
    },
  },
  async run() {
    await this.processEvents();
  },
  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
OptimoRoute	`optimoroute`	`app`	This component uses the OptimoRoute app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

About OptimoRoute#

OptimoRoute plans and optimizes routes and schedules for delivery and field service businesses.

Action#

Formatting - [Data] Convert JSON to String on Pipedream Utils

Description:Convert an object to a JSON format string

Version:0.0.6

Key:pipedream_utils-convert-json-to-string

View on GitHub

Pipedream Utils Overview#

The Pipedream Utils app is a set of pre-built functions that streamline common tasks in your workflows. It acts like a Swiss Army knife for developers, providing essential tools such as format conversion, date manipulation, and text processing. By leveraging these functions, you can reduce the boilerplate code needed for routine operations, speeding up the development of intricate automations. The Helper Functions API can be a game changer when it comes to tasks like parsing dates in user-friendly formats, encoding and decoding data, or generating UUIDs, making them more efficient and less error-prone.

Action Code#

import pipedream_utils from "../../pipedream_utils.app.mjs";
export default {
  name: "Formatting - [Data] Convert JSON to String",
  description: "Convert an object to a JSON format string",
  key: "pipedream_utils-convert-json-to-string",
  version: "0.0.6",
  annotations: {
    destructiveHint: false,
    openWorldHint: false,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    pipedream_utils,
    input: {
      label: "Input",
      description: "An object to be serialized to a JSON format string.",
      type: "object",
    },
  },
  async run({ $ }) {
    try {
      const result = JSON.stringify(this.input);
      $.export("$summary", "Successfully convert object to JSON string");
      return result;
    }
    catch (err) {
      throw new Error("Error serializing object to JSON string: " + err.toString());
    }
  },
};

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
Pipedream Utils	`pipedream_utils`	`app`	This component uses the Pipedream Utils app.
Input	`input`	`object`	An object to be serialized to a JSON format string.