Rerun Workflow with CircleCI API on Card Due Date Reminder from Pipedream API

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

Trigger workflow on

Card Due Date Reminder from the Pipedream API

Next, do this

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

Select this integration
Configure the Card Due Date Reminder trigger
1. Connect your Pipedream account
2. Connect your Pipedream account
3. Select a Board
4. Select a Time Before
Configure the Rerun Workflow action
1. Connect your CircleCI account
2. Configure Project Slug
3. Select a Pipeline ID
4. Select a Workflow ID
5. Optional- Configure Enable SSH
6. Optional- Configure From Failed
7. Optional- Select one or more Jobs
8. Optional- Configure Sparse Tree
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#

Card Due Date Reminder on Pipedream

Description:Emit new event at a specified time before a card is due.

Version:0.1.1

Key:trello-card-due-date-reminder

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import taskScheduler from "../../../pipedream/sources/new-scheduled-tasks/new-scheduled-tasks.mjs";
import trello from "../../trello.app.mjs";
import ms from "ms";
import constants from "../../common/constants.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "trello-card-due-date-reminder",
  name: "Card Due Date Reminder", /* eslint-disable-line pipedream/source-name */
  description: "Emit new event at a specified time before a card is due.",
  version: "0.1.1",
  type: "source",
  dedupe: "unique",
  props: {
    pipedream: taskScheduler.props.pipedream,
    trello,
    db: "$.service.db",
    http: "$.interface.http",
    board: {
      propDefinition: [
        trello,
        "board",
      ],
    },
    timeBefore: {
      type: "string",
      label: "Time Before",
      description: "How far before the due time the event should trigger. For example, `5 minutes`, `10 minutes`, `1 hour`.",
      default: "5 minutes",
      options: constants.NOTIFICATION_TIMES,
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.timeBefore) {
      props.timer = {
        type: "$.interface.timer",
        description: "Poll the API to schedule alerts for any newly created events",
        default: {
          intervalSeconds: ms(this.timeBefore) / 1000,
        },
      };
    }
    return props;
  },
  hooks: {
    async deactivate() {
      const ids = this._getScheduledEventIds();
      if (!ids?.length) {
        return;
      }
      for (const id of ids) {
        if (await this.deleteEvent({
          body: {
            id,
          },
        })) {
          console.log("Cancelled scheduled event");
        }
      }
      this._setScheduledEventIds();
    },
  },
  methods: {
    ...taskScheduler.methods,
    generateMeta({
      id, name: summary,
    }, now) {
      return {
        id,
        summary,
        ts: now,
      };
    },
    _getScheduledEventIds() {
      return this.db.get("scheduledEventIds");
    },
    _setScheduledEventIds(ids) {
      this.db.set("scheduledEventIds", ids);
    },
    _getScheduledCardIds() {
      return this.db.get("scheduledCardIds");
    },
    _setScheduledCardIds(ids) {
      this.db.set("scheduledCardIds", ids);
    },
    _hasDeployed() {
      const result = this.db.get("hasDeployed");
      this.db.set("hasDeployed", true);
      return result;
    },
    emitEvent(card, now) {
      const meta = this.generateMeta(card, now);
      this.$emit(card, meta);
    },
  },
  async run(event) {
    const now = event.timestamp * 1000;

    // self subscribe only on the first time
    if (!this._hasDeployed()) {
      await this.selfSubscribe();
    }

    let scheduledEventIds = this._getScheduledEventIds() || [];

    // incoming scheduled event
    if (event.$channel === this.selfChannel()) {
      const remainingScheduledEventIds = scheduledEventIds.filter((id) => id !== event["$id"]);
      this._setScheduledEventIds(remainingScheduledEventIds);
      this.emitEvent(event, now);
      return;
    }

    // schedule new events
    const scheduledCardIds = this._getScheduledCardIds() || {};
    const cards = await this.trello.getCards({
      boardId: this.board,
    });

    for (const card of cards) {
      const dueDate = card.due
        ? new Date(card.due)
        : null;
      if (!dueDate || dueDate.getTime() < Date.now()) {
        delete scheduledCardIds[card.id];
        continue;
      }

      const later = new Date(dueDate.getTime() - ms(this.timeBefore));

      if (scheduledCardIds[card.id]) {
        // reschedule if card's due date has changed
        if (card.due !== scheduledCardIds[card.id].dueDate) {
          await this.deleteEvent({
            body: {
              id: scheduledCardIds[card.id].eventId,
            },
          });
          scheduledEventIds = scheduledEventIds
            .filter((id) => id !== scheduledCardIds[card.id].eventId);
        } else {
          continue;
        }
      }

      const scheduledEventId = this.emitScheduleEvent(card, later);
      scheduledEventIds.push(scheduledEventId);
      scheduledCardIds[card.id] = {
        eventId: scheduledEventId,
        dueDate: card.due,
      };
    }
    this._setScheduledEventIds(scheduledEventIds);
    this._setScheduledCardIds(scheduledCardIds);
  },
  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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Pipedream	`trello`	`app`	This component uses the Pipedream app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Board	`board`	`string`	Select a value from the drop down menu.
Time Before	`timeBefore`	`string`	Select a value from the drop down menu:`5 minutes10 minutes15 minutes30 minutes1 hour2 hours3 hours6 hours12 hours1 day2 days3 days1 week`

Trigger Authentication#

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

About Pipedream#

Integration platform for developers

Action#

Rerun Workflow on CircleCI

Description:Reruns the specified workflow. [See the documentation](https://circleci.com/docs/api/v2/index.html#tag/Workflow/operation/rerunWorkflow)

Version:0.0.1

Key:circleci-rerun-workflow

View on GitHub

CircleCI Overview#

The CircleCI API allows for seamless integration and automation of your CI/CD pipeline. By leveraging the API through Pipedream, you can trigger builds, monitor the status of pipelines, fetch build artifacts, and interact with various aspects of your CircleCI projects. This facilitates the creation of dynamic workflows that can streamline development practices, enhance deployment strategies, and ensure continuous integration processes are more efficient and less error-prone.

Action Code#

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

export default {
  key: "circleci-rerun-workflow",
  name: "Rerun Workflow",
  description: "Reruns the specified workflow. [See the documentation](https://circleci.com/docs/api/v2/index.html#tag/Workflow/operation/rerunWorkflow)",
  version: "0.0.1",
  type: "action",
  props: {
    circleci,
    projectSlug: {
      propDefinition: [
        circleci,
        "projectSlug",
      ],
    },
    pipelineId: {
      propDefinition: [
        circleci,
        "pipelineId",
        (c) => ({
          projectSlug: c.projectSlug,
        }),
      ],
    },
    workflowId: {
      propDefinition: [
        circleci,
        "workflowId",
        (c) => ({
          pipelineId: c.pipelineId,
        }),
      ],
    },
    enableSsh: {
      type: "boolean",
      label: "Enable SSH",
      description: "Whether to enable SSH access for the triggering user on the newly-rerun job. Requires the jobs parameter to be used and so is mutually exclusive with the from_failed parameter.",
      optional: true,
    },
    fromFailed: {
      type: "boolean",
      label: "From Failed",
      description: "Whether to rerun the workflow from the failed job. Mutually exclusive with the jobs parameter.",
      optional: true,
    },
    jobIds: {
      propDefinition: [
        circleci,
        "jobIds",
        (c) => ({
          workflowId: c.workflowId,
        }),
      ],
    },
    sparseTree: {
      type: "boolean",
      label: "Sparse Tree",
      description: "",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.circleci.rerunWorkflow({
      $,
      workflowId: this.workflowId,
      data: {
        enable_ssh: this.enableSsh,
        from_failed: this.fromFailed,
        jobs: typeof this.jobIds === "string"
          ? JSON.parse(this.jobIds)
          : this.jobIds,
        sparse_tree: this.sparseTree,
      },
    });
    $.export("$summary", `Successfully started a rerun of workflow with ID: ${this.workflowId}`);
    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
CircleCI	`circleci`	`app`	This component uses the CircleCI app.
Project Slug	`projectSlug`	`string`	Project slug in the form `vcs-slug/org-name/repo-name` (found in Project Settings)
Pipeline ID	`pipelineId`	`string`	Select a value from the drop down menu.
Workflow ID	`workflowId`	`string`	Select a value from the drop down menu.
Enable SSH	`enableSsh`	`boolean`	Whether to enable SSH access for the triggering user on the newly-rerun job. Requires the jobs parameter to be used and so is mutually exclusive with the from_failed parameter.
From Failed	`fromFailed`	`boolean`	Whether to rerun the workflow from the failed job. Mutually exclusive with the jobs parameter.
Jobs	`jobIds`	`string[]`	Select a value from the drop down menu.
Sparse Tree	`sparseTree`	`boolean`

Action Authentication#

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

An API token can be created using the account dashboard. More info via API Overview.

About CircleCI#

Continuous integration and delivery platform

More Ways to Connect CircleCI + Pipedream#

Other Popular Integrations#

Create a Subscription with Pipedream API on New Job Completed (Instant) from CircleCI API

CircleCI + Pipedream

Rerun Workflow with CircleCI API on Card Due Date Reminder from Pipedream API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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