Explore Pricing Docs Community Blog Careers

Filter

Specify a condition that your workflow must meet and whether you'd like to proceed or end workflow execution.

Explore

Apps

Filter

GitHub

Integrate the Filter API with the GitHub API

Setup the Filter API trigger to run a workflow which integrates with the GitHub API. Pipedream's integration platform allows you to integrate Filter and GitHub remarkably fast. Free for developers.

Popular Ways to Connect Filter with GitHub#

Continue execution if a condition Is met with Filter API on New Branch (Instant) from GitHub API

GitHub + Filter

Try it

Continue execution if a condition Is met with Filter API on New Card in Column (Classic Projects) from GitHub API

GitHub + Filter

Try it

Continue execution if a condition Is met with Filter API on New Collaborator (Instant) from GitHub API

GitHub + Filter

Try it

Continue execution if a condition Is met with Filter API on New Commit (Instant) from GitHub API

GitHub + Filter

Try it

Continue execution if a condition Is met with Filter API on New Commit Comment (Instant) from GitHub API

GitHub + Filter

Try it

Popular Filter and GitHub Triggers#

New Branch (Instant) from the GitHub API

Emit new events when a new branch is created

Try it

New Card in Column (Classic Projects) from the GitHub API

Emit new event when a (classic) project card is created or moved to a specific column. For Projects V2 use New Issue with Status trigger. More information here

Try it

New Collaborator (Instant) from the GitHub API

Emit new events when collaborators are added to a repo

Try it

New Commit (Instant) from the GitHub API

Emit new events on new commits to a repo or branch

Try it

New Commit Comment (Instant) from the GitHub API

Emit new events on new commit comments

Try it

Popular Filter and GitHub Actions#

Continue execution if a condition Is met with the Filter API

Continue workflow execution only if a condition is met

Try it

Create Issue with the GitHub API

Create a new issue in a Gihub repo. See docs here

Try it

End execution if a condition is met with the Filter API

End workflow execution if a condition is met

Try it

Search Issues and Pull Requests with the GitHub API

Find issues and pull requests by state and keyword. See docs here

Try it

Create Branch with the GitHub API

Create a new branch in a Github repo. See docs here

Try it

Overview of Filter#

The Filter API is a great way to build powerful workflows that can manipulate
and transform data. Here are some examples of what you can build using the
Filter API:

A workflow that transforms data from one format to another
A workflow that filters out data that does not meet certain criteria
A workflow that sorts data in a specific order
A workflow that calculates statistics or aggregates data
A workflow that combines data from multiple sources

Connect Filter#

export default defineComponent({
  async run({ steps, $ }) {
    let condition = false
    if (condition == false) {
      $.flow.exit("Ending workflow early because the condition is false")
    } else {
        $.export("$summary", "Continuing workflow, since condition for ending was not met.")
    }
  },
})

Connect GitHub#

import { axios } from "@pipedream/platform"
export default defineComponent({
  props: {
    github: {
      type: "app",
      app: "github",
    }
  },
  async run({steps, $}) {
    return await axios($, {
      url: `https://api.github.com/user`,
      headers: {
        Authorization: `Bearer ${this.github.$auth.oauth_access_token}`,
        "X-GitHub-Api-Version": `2022-11-28`,
      },
    })
  },
})