🎉 Pipedream raises $20M Series A 🎉

Read the blog post and TC Techcrunch article.

Explore Pricing Support Docs Community Blog Careers (we're hiring!)

← Pipedream + GitHub integrations

Create Issue with GitHub APIon New Scheduled Tasks from Pipedream API

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

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

Create Issue with the GitHub API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Pipedream trigger and GitHub action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Scheduled Tasks trigger
1. Connect your Pipedream account
2. Optional- Configure Secret
Configure the Create Issue action
1. Connect your GitHub account
2. Select a Repo
3. Configure Title
4. Optional- Configure Body
5. Optional- Select one or more Labels
6. Optional- Select a Milestone
7. Optional- Configure Assignees
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, open source 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 Scheduled Tasks on Pipedream

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time

Version:0.1.0

Key:pipedream-new-scheduled-tasks

View on GitHub

Trigger Code#

import pipedream from "../../pipedream.app.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.1.0",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() { return "self"; },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() { return "$in"; },
  },
  async run(event) {
    const {
      body,
      headers,
      path,
      $channel,
      $id,
    } = event;

    const componentId = process.env.PD_COMPONENT;
    const selfChannel = this.selfChannel();
    const inChannel = this.queuedEventsChannel();

    // Subscribe the component to itself. We do this here because even in
    // the activate hook, the component isn't available to take subscriptions.
    // Scheduled tasks are sent to the self channel, which emits the message at
    // the specified delivery_ts to this component.
    const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
    if (!isSubscribedToSelf) {
      console.log(`Subscribing to ${selfChannel} channel for event source`);
      console.log(
        await this.pipedream.subscribe(componentId, componentId, selfChannel),
      );
      this.db.set("isSubscribedToSelf", true);
    }

    // SCHEDULE NEW TASK
    if (path === "/schedule") {
      const {
        timestamp,
        message,
      } = body;
      const errors = [];

      // timestamp should be an ISO 8601 string. Parse and check
      // for validity below.
      const epoch = Date.parse(timestamp);

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }
      if (!timestamp) {
        errors.push(
          "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
        );
      }
      if (timestamp && !epoch) {
        errors.push("Timestamp isn't a valid ISO 8601 string");
      }
      if (!message) {
        errors.push("No message passed in payload");
      }
      if (errors.length) {
        console.log(errors);
        this.http.respond({
          status: 400,
          body: {
            errors,
          },
          headers: {
            "content-type": "application/json",
          },
        });
        return;
      }

      const $id = uuid();
      this.$emit(
        {
          ...body,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      this.http.respond({
        status: 200,
        body: {
          msg: "Successfully scheduled task",
          id: $id,
        },
        headers: {
          "Content-Type": "application/json",
        },
      });

      return;
    }

    // CANCEL SCHEDULED TASK
    // The user must pass a scheduled event UUID they'd like to cancel
    // We lookup the event by ID and delete it
    if (path === "/cancel") {
      const { id } = body;

      if (this.secret && headers["x-pd-secret"] !== this.secret) {
        this.http.respond({
          status: 400,
          body: {
            msg: "Secret on incoming request doesn't match the configured secret",
          },
          headers: {
            "content-type": "application/json",
          },
        });
        return;
      }

      let msg, status;
      try {
        // List events in the $in channel - the queue of
        // scheduled events, to be emitted in the future
        const events = await this.pipedream.listEvents(
          componentId,
          inChannel,
        );
        console.log("Events: ", events);

        // Find the event in the list by id
        const eventToCancel = events.data.find((e) => {
          const { metadata } = e;
          return metadata.id === id;
        });

        console.log("Event to cancel: ", eventToCancel);

        if (!eventToCancel) {
          console.log(`No event with ${id} found`);
          this.http.respond({
            status: 404,
            body: {
              msg: `No event with ${id} found`,
            },
          });
          return;
        }

        // Delete the event
        console.log(
          await this.pipedream.deleteEvent(
            componentId,
            eventToCancel.id,
            inChannel,
          ),
        );
        status = 200;
        msg = `Cancelled scheduled task for event ${id}`;
      } catch (err) {
        status = 500;
        msg = "Failed to schedule task. Please see the logs";
        console.log(err);
      }

      this.http.respond({
        status,
        body: {
          msg,
        },
        headers: {
          "content-type": "application/json",
        },
      });

      return;
    }

    // INCOMING SCHEDULED EMIT
    if ($channel === selfChannel) {
      // Delete the channel name and id from the incoming event,
      // which were used only as metadata
      delete event.$channel;
      delete event.$id;
      this.$emit(event, {
        summary: JSON.stringify(event),
        id: $id,
        ts: +new Date(),
      });
    }
  },
};

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.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between component invocations.

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.

Your API key is in your Account Settings (Settings -> Account).

About Pipedream#

Integration platform for developers

Action#

Create Issue on GitHub

Description:Create a new issue in a Gihub repo.

Version:0.0.14

Key:github-create-issue

View on GitHub

Action Code#

const github = require("../../github.app.js");
const { Octokit } = require("@octokit/rest");

module.exports = {
  key: "github-create-issue",
  name: "Create Issue",
  description: "Create a new issue in a Gihub repo.",
  version: "0.0.14",
  type: "action",
  props: {
    github,
    repoFullName: {
      propDefinition: [
        github,
        "repoFullName",
      ],
    },
    title: {
      propDefinition: [
        github,
        "issueTitle",
      ],
    },
    body: {
      propDefinition: [
        github,
        "issueBody",
      ],
    },
    labels: {
      propDefinition: [
        github,
        "labelNames",
        (c) => ({
          repoFullName: c.repoFullName,
        }),
      ],
      optional: true,
    },
    milestone: {
      propDefinition: [
        github,
        "milestone",
        (c) => ({
          repoFullName: c.repoFullName,
        }),
      ],
      optional: true,
    },
    assignees: {
      propDefinition: [
        github,
        "issueAssignees",
      ],
    },
  },
  async run() {
    const octokit = new Octokit({
      auth: this.github.$auth.oauth_access_token,
    });

    return (await octokit.issues.create({
      owner: this.repoFullName.split("/")[0],
      repo: this.repoFullName.split("/")[1],
      title: this.title,
      body: this.body,
      labels: this.labels,
      assignees: this.assignees,
      milestone: this.milestone,
    })).data;
  },
};

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
GitHub	`github`	`app`	This component uses the GitHub app.
Repo	`repoFullName`	`string`	Select a value from the drop down menu.
Title	`title`	`string`	The title of the issue.
Body	`body`	`string`	Optionally add details describing the issue (this field supports Github markdown).
Labels	`labels`	`string[]`	Select a value from the drop down menu.
Milestone	`milestone`	`string`	Select a value from the drop down menu.
Assignees	`assignees`	`string[]`	Optionally enter Github usernames to assign to this issue. Add one username per row or pass an array of usernames in `{{...}}` as a custom expression. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

Action 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:packages

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.