Start Tracking Time with TrackingTime API on New Commit from GitHub API

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

Trigger workflow on

New Commit from the GitHub API

Next, do this

Start Tracking Time with the TrackingTime 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 GitHub trigger and TrackingTime action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Commit trigger
1. Configure eventTypeInfo
2. Connect your GitHub account
3. Select a Repository
4. Select a Branch
Configure the Start Tracking Time action
1. Connect your TrackingTime account
2. Select a Task ID
3. Optional- Select a Project ID
4. Optional- Configure Date
5. Optional- Configure Estimated Time
6. Optional- Configure Stop Running Task
7. Optional- Configure Return Task
8. Optional- Configure Tags
9. Optional- Configure Timezone
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 Commit on GitHub

Description:Emit new event when commits are pushed to a branch

Version:1.0.6

Key:github-new-commit

View on GitHub

GitHub Overview#

The GitHub API is a powerful gateway to interaction with GitHub's vast web of data and services, offering a suite of endpoints to manipulate and retrieve information on repositories, pull requests, issues, and more. Harnessing this API on Pipedream, you can orchestrate automated workflows that respond to events in real-time, manage repository data, streamline collaborative processes, and connect GitHub with other services for a more integrated development lifecycle.

Trigger Code#

import common from "../common/common-flex.mjs";
import {
  getSampleTimerEvent, getSampleWebhookEvent,
} from "./common-sample-events.mjs";

export default {
  ...common,
  key: "github-new-commit",
  name: "New Commit",
  description: "Emit new event when commits are pushed to a branch",
  version: "1.0.6",
  type: "source",
  dedupe: "unique",
  props: {
    eventTypeInfo: {
      type: "alert",
      alertType: "info",
      content: "**Note:** one event is emitted for each individual commit, even if they are received at the same time.",
    },
    ...common.props,
    branch: {
      propDefinition: [
        common.props.github,
        "branch",
        (c) => ({
          repoFullname: c.repoFullname,
        }),
      ],
    },
  },
  methods: {
    ...common.methods,
    _getLastTimestamp() {
      return this.db.get("lastTimestamp") ?? Date.now();
    },
    _setLastTimestamp(value) {
      this.db.set("lastTimestamp", value);
    },
    getSampleTimerEvent,
    getSampleWebhookEvent,
    getWebhookEvents() {
      return [
        "push",
      ];
    },
    getSummary(item) {
      return `New commit: ${item.commit?.message ?? item.message}`;
    },
    async onWebhookTrigger(event) {
      const {
        body, headers,
      } = event;
      if (body?.ref?.split?.("refs/heads/").pop() === this.branch.split("/").pop()) {
        body.commits.forEach((commit) => {
          const { id } = commit;
          this.emitEvent({
            id,
            headers,
            item: commit,
          });
        });
      }
    },
    async onTimerTrigger() {
      const { repoFullname } = this;
      const timestamp = this._getLastTimestamp();
      const since = new Date(timestamp).toISOString()
        .slice(0, -5) + "Z";
      const sha = this.branch.split("/").pop();
      const items = await this.github.getCommits({
        repoFullname,
        sha,
        since,
      });

      const savedItems = this._getSavedItems();
      const shouldEmit = this.shouldEmit();

      items
        .filter(({ sha }) => !savedItems.includes(sha))
        .sort((a, b) => {
          const dateA = new Date(a.commit.author.date);
          const dateB = new Date(b.commit.author.date);
          return dateA - dateB;
        })
        .forEach((item) => {
          const id = item.sha;
          if (shouldEmit) {
            this.emitEvent({
              id,
              item,
            });
          }
          savedItems.push(id);
        });

      this._setSavedItems(savedItems);
      this._setLastTimestamp(Date.now());
    },
    getHttpDocsLink() {
      return "https://docs.github.com/en/webhooks/webhook-events-and-payloads#push";
    },
    getTimerDocsLink() {
      return "https://docs.github.com/en/rest/commits/commits?apiVersion=2022-11-28#list-commits";
    },
  },
};

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
GitHub	`github`	`app`	This component uses the GitHub app.
Repository	`repoFullname`	`string`	Select a value from the drop down menu.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Branch	`branch`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

repoadmin:orgadmin:public_keyadmin:org_hookgistprojectnotificationsuserwrite:discussionwrite:packagesread:packagesadmin:repo_hook

About GitHub#

Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.

Action#

Start Tracking Time on TrackingTime

Description:Start tracking time of a task. [See the documentation](https://api.trackingtime.co/doc/time_tracking.html#sync:~:text=Sync%20tracking%20event-,Start%20Tracking%20Time,-Starts%20a%20timer)

Version:0.0.1

Key:trackingtime-start-tracking-time

View on GitHub

TrackingTime Overview#

The TrackingTime API enables the automation of time tracking, task management, and reporting processes. In Pipedream, you can use this API to create powerful workflows that connect TrackingTime with other apps to streamline productivity, enhance project management, and generate insights on time allocation. Automate tasks based on project activities, sync time entries with calendars, or trigger notifications based on tracked time data.

Action Code#

import app from "../../trackingtime.app.mjs";

export default {
  name: "Start Tracking Time",
  version: "0.0.1",
  key: "trackingtime-start-tracking-time",
  description: "Start tracking time of a task. [See the documentation](https://api.trackingtime.co/doc/time_tracking.html#sync:~:text=Sync%20tracking%20event-,Start%20Tracking%20Time,-Starts%20a%20timer)",
  type: "action",
  props: {
    app,
    taskId: {
      propDefinition: [
        app,
        "taskId",
      ],
    },
    projectId: {
      propDefinition: [
        app,
        "projectId",
      ],
      optional: true,
    },
    date: {
      label: "Date",
      description: "The event's start date. Format ISO 8601: `yyyy-MM-dd HH:mm:ss` like `2014-01-31 17:30:59`",
      type: "string",
      optional: true,
    },
    estimatedTime: {
      label: "Estimated Time",
      description: "Set a new estimated time for this task",
      type: "string",
      optional: true,
    },
    stopRunningTask: {
      label: "Stop Running Task",
      description: "If set to true, any currently running task will be stopped before the new one is started.",
      type: "boolean",
      optional: true,
    },
    returnTask: {
      label: "Return Task",
      description: "If set to true, a task object is returned",
      type: "boolean",
      optional: true,
    },
    tags: {
      label: "Tags",
      description: "An array of tags to be added to the newly created time entry. E.g. `[{\"n\":\"name\",\"c\":\"color\",\"v\":\"value\",\"t\":\"type\"}]`",
      type: "boolean",
      optional: true,
    },
    timezone: {
      label: "Timezone",
      description: "The user's timezone as `GMT+3` or `GMT+03:00`",
      type: "string",
      optional: true,
    },
  },
  async run({ $ }) {
    const tags = typeof this.tags === "string"
      ? JSON.parse(this.tags)
      : this.tags;

    const response = await this.app.startTrackingTime({
      $,
      taskId: this.taskId,
      params: {
        date: this.date,
        projectId: this.projectId,
        return_task: this.returnTask,
        stop_running_task: this.stopRunningTask,
        estimated_time: this.estimatedTime,
        timezone: this.timezone,
        tags,
      },
    });

    if (response) {
      $.export("$summary", `Successfully started tracking time of the task ID ${this.taskId}`);
    }

    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
TrackingTime	`app`	`app`	This component uses the TrackingTime app.
Task ID	`taskId`	`string`	Select a value from the drop down menu.
Project ID	`projectId`	`string`	Select a value from the drop down menu.
Date	`date`	`string`	The event's start date. Format ISO 8601: `yyyy-MM-dd HH:mm:ss` like `2014-01-31 17:30:59`
Estimated Time	`estimatedTime`	`string`	Set a new estimated time for this task
Stop Running Task	`stopRunningTask`	`boolean`	If set to true, any currently running task will be stopped before the new one is started.
Return Task	`returnTask`	`boolean`	If set to true, a task object is returned
Tags	`tags`	`boolean`	An array of tags to be added to the newly created time entry. E.g. `[{"n":"name","c":"color","v":"value","t":"type"}]`
Timezone	`timezone`	`string`	The user's timezone as `GMT+3` or `GMT+03:00`

Start Tracking Time with TrackingTime API on New Commit from GitHub API

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

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,200+apps by most popular

1
-
24
of
2,200+
apps by most popular