[Data] Convert JSON to String with Formatting API on New Comment Added from TeamGantt API

Pipedream makes it easy to connect APIs for Formatting, TeamGantt and 2,200+ other apps remarkably fast.

Trigger workflow on

New Comment Added from the TeamGantt API

Next, do this

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

Select this integration
Configure the New Comment Added trigger
1. Connect your TeamGantt account
2. Configure Polling interval
3. Select a Target
Configure the [Data] Convert JSON to String action
1. Connect your Formatting 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 Comment Added on TeamGantt

Description:Emit new event when a new comment is created.

Version:0.0.1

Key:teamgantt-new-comment-added

View on GitHub

TeamGantt Overview#

The TeamGantt API allows you to interact programmatically with your TeamGantt project management data. With it, you can create, read, update, and delete various project elements, such as tasks, milestones, and time entries. Integrating the TeamGantt API with Pipedream enables you to automate your project workflows, sync data across platforms, and react to events in real-time. By leveraging Pipedream's capabilities, you can connect TeamGantt to a myriad of other apps and services to streamline your project management processes.

Trigger Code#

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

export default {
  key: "teamgantt-new-comment-added",
  name: "New Comment Added",
  version: "0.0.1",
  description: "Emit new event when a new comment is created.",
  type: "source",
  dedupe: "unique",
  props: {
    teamgantt,
    db: "$.service.db",
    timer: {
      label: "Polling interval",
      description: "Pipedream will poll the TeamGantt on this schedule",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    type: {
      type: "string",
      label: "Target",
      description: "The resource type that contains the respective comments.",
      options: [
        "projects",
        "groups",
        "tasks",
      ],
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    const projectId = {
      type: "string",
      label: "Project Id",
      description: "The id of the project that contains the respective comments.",
      options: async () => {
        const { projects } = await this.teamgantt.listProjects();

        return projects.map(({
          id: value, name: label,
        }) => ({
          label,
          value,
        }));
      },
    };
    switch (this.type) {
    case "projects":
      props.projectId = projectId;
      break;
    case "groups":
      props.projectId = projectId;
      props.groupId = {
        type: "string",
        label: "Group Id",
        description: "The id of the group that contains the respective comments.",
        options: async () => {
          const groups = await this.teamgantt.listGroups({
            params: {
              project_ids: [
                this.projectId,
              ],
            },
          });

          return groups.map(({
            id: value, name: label,
          }) => ({
            label,
            value,
          }));
        },
      };
      break;
    case "tasks":
      props.taskId = {
        type: "string",
        label: "Task Id",
        description: "The id of the task that contains the respective comments.",
        options: async () => {
          const tasks = await this.teamgantt.listTasks();

          return tasks.map(({
            id: value, name: label,
          }) => ({
            label,
            value,
          }));
        },
      };
      break;
    }
    return props;
  },
  methods: {
    _getLastDate() {
      return this.db.get("lastDate") || 0;
    },
    _setLastDate(lastDate) {
      this.db.set("lastDate", lastDate);
    },
    async startEvent(maxResults = 0) {
      let responseArray = [];
      const { teamgantt } = this;
      const lastDate = this._getLastDate();
      let items = await teamgantt.listComments({
        ...this,
      });

      if (maxResults) {
        items = items.slice(-maxResults);
      }

      for await (const item of items.reverse()) {
        if (item.id <= lastDate) break;
        responseArray.push(item);
      }
      if (responseArray.length) this._setLastDate(responseArray[0].id);

      for (const item of responseArray.reverse()) {
        this.$emit(
          item,
          {
            id: item.id,
            summary: `A new comment with id: "${item.id}" was added!`,
            ts: new Date(),
          },
        );
      }
    },
  },
  hooks: {
    async deploy() {
      await this.startEvent(25);
    },
  },
  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
TeamGantt	`teamgantt`	`app`	This component uses the TeamGantt app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	Pipedream will poll the TeamGantt on this schedule
Target	`type`	`string`	Select a value from the drop down menu:`projectsgroupstasks`

Trigger Authentication#

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

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

About TeamGantt#

Software that helps teams work together, without losing sight of the big picture.

Action#

[Data] Convert JSON to String on Formatting

Description:Convert an object to a JSON format string

Version:0.0.5

Key:formatting-convert-json-to-string

View on GitHub

Action Code#

import { defineAction } from "@pipedream/types";
import app from "../../app/formatting.app.mjs";
export default defineAction({
    name: "[Data] Convert JSON to String",
    description: "Convert an object to a JSON format string",
    key: "formatting-convert-json-to-string",
    version: "0.0.5",
    type: "action",
    props: {
        app,
        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());
        }
    },
});