Skip to content

Latest commit

 

History

History
236 lines (176 loc) · 11.7 KB

README.md

File metadata and controls

236 lines (176 loc) · 11.7 KB
Raw

pipedream

Pipedream is an integration platform for developers.

Pipedream provides a free, hosted platform for connecting apps and developing event-driven automations. The platform has over 800 fully-integrated applications, so you can use pre-built components to quickly connect to send messages to Slack, add a new row to Google Sheets, and more. You can also run any Node.js, Python, Golang, or Bash code when you need custom logic.


HTTP trigger + step selection menu

This repo contains:

This README explains the key features of the platform and how to get started.

To get support, please visit https://pipedream.com/support.

Key Features

  • Workflows - Workflows run automations. Workflows are sequence of steps - pre-built actions or custom Node.js, Python, Golang, or Bash code - triggered by an event (HTTP request, timer, when a new row is added to a Google Sheets, and more).
  • Event Sources - Sources trigger workflows. They emit events from services like GitHub, Slack, Airtable, RSS and more. When you want to run a workflow when an event happens in any third-party app, you're using an event source.
  • Actions - Actions are pre-built code steps that you can use in a workflow to perform common operations across Pipedream's 800+ API integrations. For example, you can use actions to send email, add a row to a Google Sheet, and more.
  • Custom code - Most integrations require custom logic. Code is often the best way to express that logic, so Pipedream allows you to run any Node.js, Python, Golang, or Bash code. You can import any package from the languages' package managers, connect to any Pipedream connected app, and more. Pipedream is "low-code" in the best way: you can use pre-built components when you're performing common actions, but you can write custom code when you need to.
  • Destinations - Deliver events asynchronously to common destinations like Amazon S3, Snowflake, HTTP and email
  • Free - No fees for individual developers (see limits)

Demo

Click the image below to watch a brief demo on YouTube.


Pipedream demo static image

Workflows

Workflows are a sequence of linear steps triggered by an event (like an HTTP request, or when a new row is added to a Google sheet). You can quickly develop complex automations using workflows and connect to any of our 800+ integrated apps.

See our workflow quickstart to get started.

Event Sources

Event Sources watch for new data from services like GitHub, Slack, Airtable, RSS and more. When a source finds a new event, it emits it, triggering any linked workflows.

You can also consume events emitted by sources using Pipedream's REST API or a private, real-time SSE stream.

When a pre-built source doesn't exist for your use case, you can build your own. Here is the simplest event source: it exposes an HTTP endpoint you can send any request to, and prints the contents of the request when invoked:

export default {
  name: "http",
  version: "0.0.1",
  props: {
    http: "$.interface.http",
  },
  run(event) {
    console.log(event); // event contains the method, payload, etc.
  },
};

You can find the code for all pre-built sources in the components directory. If you find a bug or want to contribute a feature, see our contribution guide.

Actions

Actions are pre-built code steps that you can use in a workflow to perform common operations across Pipedream's 500+ API integrations. For example, you can use actions to send email, add a row to a Google Sheet, and more.

You can create your own actions, which you can re-use across workflows. You can also publish actions to the entire Pipedream community, making them available for anyone to use.

Here's an action that accepts a name as input and prints it to the workflow's logs:

export default {
  name: "Action Demo",
  description: "This is a demo action",
  key: "action_demo",
  version: "0.0.1",
  type: "action",
  props: {
    name: {
      type: "string",
      label: "Name",
    }
  },
  async run() {
    return `hello ${this.name}!`
  },
}

You can find the code for all pre-built actions in the components directory. If you find a bug or want to contribute a feature, see our contribution guide.

Custom code

Most integrations require custom logic. Code is often the best way to express that logic, so Pipedream allows you to run custom code in a workflow using:

Node.js Python
Go Bash

You can import any package from the languages' package managers by declaring the imports directly in code. Pipedream will parse and download the necessary dependencies.

// Node.js
import axios from 'axios'
# Python
import pandas as pd
// Go
import (
    "fmt"
    pd "github.com/PipedreamHQ/pipedream-go"
)

You can also connect to any Pipedream connected app in custom code steps. For example, you can connect your Slack account and send a message to a channel:

import { WebClient } from '@slack/web-api'

export default defineComponent({
  props: {
    // This creates a connection called "slack" that connects a Slack account.
    slack: {
      type: 'app',
      app: 'slack'
    }
  },
  async run({ steps, $ }) {
    const web = new WebClient(this.slack.$auth.oauth_access_token)

    return await web.chat.postMessage({
      text: "Hello, world!",
      channel: "#general",
    })
  }
});

Destinations

Destinations, like actions, abstract the connection, batching, and delivery logic required to send events to services like Amazon S3, or targets like HTTP and email.

For example, sending data to an Amazon S3 bucket is as simple as calling $send.s3():

$send.s3({
  bucket: "your-bucket-here",
  prefix: "your-prefix/",
  payload: event.body,
});

Pipedream supports the following destinations:

Contributors

Thank you to everyone who has contributed to the Pipedream codebase. We appreciate you!

Pricing

Pipedream has a generous free tier. You can run sources and workflows for free within the limits of the free tier. If you hit these limits, you can upgrade to one of our paid tiers.

Limits

The Pipedream platform imposes some runtime limits on sources and workflows. Read more about those in our docs.

Found a Bug? Have a Feature to suggest?

Before adding an issue, please search the existing issues or reach out to our team to see if a similar request already exists.

If an issue exists, please add a reaction or add a comment detailing your specific use case.

If an issue doesn't yet exist and you need to create one, please use the issue templates.

Security

You can read about our platform security and privacy here.

If you'd like to report a suspected vulnerability or security issue, or have any questions about the security of the product, please contact our security team at [email protected].