Filter

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

Integrate the Filter API with the Bash API

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

Continue execution if a condition Is met with the Filter API

Continue workflow execution only if a condition is met

 
Try it
Run Bash Code with the Bash API

Run any Bash in a Pipedream step within your workflow. Refer to the Pipedream Bash docs to learn more.

 
Try it
End execution if a condition is met with the Filter API

End workflow execution if a condition is met

 
Try it

Overview of Filter

The Filter API in Pipedream allows for real-time data processing within workflows. It's designed to evaluate data against predefined conditions, enabling workflows to branch or perform specific actions based on those conditions. This API is instrumental in creating efficient, targeted automations that respond dynamically to diverse datasets. Using the Filter API, you can refine streams of data, ensuring that subsequent steps in your Pipedream workflow only execute when the data meets your specified criteria. This cuts down on unnecessary processing and facilitates the creation of more intelligent, context-aware systems.

Connect Filter

1
2
3
4
5
6
7
8
9
10
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 Bash

1
2
3
4
5
6
7
# $PIPEDREAM_STEPS file contains data from previous steps
cat $PIPEDREAM_STEPS | jq .trigger.context.id

# Write data to $PIPEDREAM_EXPORTS to return it from the step
# Exports must be written as key=value
echo foo=bar >> $PIPEDREAM_EXPORTS