Filter

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

Go to site
Explore
/
Apps
/
Filter

Filter API Integrations

Build and run workflows using the Filter API. Use 1000s of source-available triggers and actions across 2,100+ apps. Or write custom code to integrate any app or API in seconds.

Overview

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.

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.")
    }
  },
})

Choose an API to Connect with Filter API

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

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify Developer App
Shopify Developer App
Shopify is a user-friendly e-commerce platform that helps small businesses build an online store and sell online through one streamlined dashboard.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Premium
ServiceNow
ServiceNow
The smarter way to workflow
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.

Example Use Cases

  • Customer Support Ticket Prioritization: Automate the prioritization of incoming customer support tickets by filtering them based on keywords, severity, or customer tier. Once filtered, tickets can be routed to the appropriate support staff or escalated if they meet certain critical conditions.

  • Social Media Sentiment Analysis: Stream social media mentions into a Pipedream workflow, and use the Filter API to only process posts with negative sentiment. These can then be forwarded to your customer relations team, or logged into a CRM for follow-up, ensuring proactive engagement with potentially dissatisfied customers.

  • E-commerce Order Processing: Implement a workflow that filters incoming e-commerce orders by value, location, or item availability. High-value orders could trigger an instant alert to the sales team, whereas orders with out-of-stock items could be placed on hold automatically, improving operational efficiency and customer satisfaction.

Continue execution if a condition Is met with Filter API on New or Updated Event from Google Calendar API
Google Calendar + Filter
 
Try it
Continue execution if a condition Is met with Filter API on New Issue Event from Sifter API
Sifter + Filter
 
Try it
Continue execution if a condition Is met with Filter API on New Posts (Instant) from Discourse API
Discourse + Filter
 
Try it
End execution if a condition is met with Filter API on New Requests from HTTP / Webhook API
HTTP / Webhook + Filter
 
Try it
End execution if a condition is met with Filter API on New Item in Feed from RSS API
RSS + Filter
 
Try it
Continue execution if a condition Is met with the Filter API

Continue workflow execution only if a condition is met

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

End workflow execution if a condition is met

 
Try it

Authentication

The Filter API does not require authentication.