← GitHub

New Card in Column (Instant) from GitHub API

Pipedream makes it easy to connect APIs for GitHub and 800+ other apps remarkably fast.

Trigger workflow on
New Card in Column (Instant) from the GitHub API
Next, do this
Connect to 800+ APIs using code and no-code building blocks
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Trigger a workflow on New Card in Column (Instant) with GitHub API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the New Card in Column (Instant) trigger
    1. Connect your GitHub account
    2. Select a Repository
    3. Select a Project
    4. Select a Column
  2. Add steps to connect to 800+ APIs using code and no-code building blocks
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, open source component from Pipedream's GitHub repo. The component is 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.

New Card in Column (Instant) on GitHub
Description:Emit new event when a project card is created or moved to a specific column
Version:0.1.0
Key:github-new-card-in-column

Code

import common from "../common/common-webhook.mjs";

export default {
  ...common,
  key: "github-new-card-in-column",
  name: "New Card in Column (Instant)",
  description: "Emit new event when a project card is created or moved to a specific column",
  version: "0.1.0",
  type: "source",
  props: {
    ...common.props,
    project: {
      propDefinition: [
        common.props.github,
        "project",
        (c) => ({
          repoFullname: c.repoFullname,
        }),
      ],
    },
    column: {
      propDefinition: [
        common.props.github,
        "column",
        (c) => ({
          project: c.project,
        }),
      ],
      withLabel: true,
    },
  },
  methods: {
    ...common.methods,
    getWebhookEvents() {
      return [
        "project_card",
      ];
    },
    getThisColumnLabel() {
      if (typeof this.column ===  "object") {
        return this.column.label;
      }
      return this.column;
    },
    getThisColumnValue() {
      if (typeof this.column ===  "object") {
        return this.column.value;
      }
      return this.column;
    },
    isCardInThisColumn(card) {
      const { column_id: columnId } = card;
      return columnId === this.getThisColumnValue();
    },
    generateMeta(card) {
      return {
        id: card.id,
        summary: `New card in ${this.getThisColumnLabel()}: ${card.note}`,
        ts: Date.parse(card.updated_at),
      };
    },
    async loadHistoricalEvents() {
      const cards = await this.github.getProjectCards({
        columnId: this.getThisColumnValue(),
        per_page: 25,
      });
      for (const card of cards) {
        await this.processCard(card);
      }
    },
    async processCard(card) {
      const meta = this.generateMeta(card);
      const issue = await this.github.getIssueFromProjectCard({
        repoFullname: this.repoFullname,
        cardId: card.id,
      });
      this.$emit({
        card,
        issue,
      }, meta);
    },
  },
  async run(event) {
    const card = event.body.project_card;
    if (!card) {
      console.log("No card in event. Skipping event.");
      return;
    }

    if (!this.isCardInThisColumn(card)) {
      console.log(`Card not in ${this.getThisColumnLabel()}. Skipping...`);
      return;
    }

    this.processCard(card);
  },
};

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.
LabelPropTypeDescription
GitHubgithubappThis component uses the GitHub app.
RepositoryrepoFullnamestringSelect a value from the drop down menu.
N/Adb$.service.dbThis component uses $.service.db to maintain state between component invocations.
N/Ahttp$.interface.httpThis 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.
ProjectprojectintegerSelect a value from the drop down menu.
ColumncolumnintegerSelect a value from the drop down menu.

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_hookgistnotificationsuserwrite: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.