pipedream README

The project's README from github.com/PipedreamHQ/pipedream. As one markdown file: README.md.

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 1,000 fully-integrated applications, so you can use pre-built components to quickly 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. Pipedream has demonstrated SOC 2 compliance and can provide a SOC 2 Type 2 report upon request (please email [email protected]).


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

Demo

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


Pipedream demo static image

Workflows

Workflows are sequences 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 1,000+ 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].

pipedream (PipedreamHQ/pipedream)

Searching Database…

11.8K ·GitHub
这是什么?Pipedream 是一个免费的托管式集成平台,面向开发者,可用于连接各种 API 并构建事件驱动的自动化流程,内置超过 1,000 个应用集成。
这是需要我安装的框架,还是托管服务?它主要是一项托管(云端)平台,你通过网页界面使用;本仓库则是其预构建集成组件、文档和路线图的开源代码。
我该如何构建第一个工作流?你在托管平台上构建工作流,方法是串联预构建的动作或自定义代码步骤,并由事件源触发,例如 HTTP 请求、定时器或应用事件;详见文档中的工作流快速入门指南。
自定义逻辑可以使用哪些编程语言?你可以用 Node.js、Python、Golang 或 Bash 编写自定义步骤,并在代码中直接导入对应语言包管理器中的任意包。
免费套餐有使用限制吗?有的,平台会对免费账户的事件源和工作流设置运行时限制;如果超出限制,你可以升级到付费套餐。
Pipedream 有合规认证吗?Pipedream 已符合 SOC 2 合规要求,并可应要求提供 SOC 2 Type 2 报告。
什么是事件源?事件源用于监听 GitHub、Slack、Airtable 或 RSS 等第三方应用,当事件发生时发出事件,进而触发与之关联的任何工作流。
什么是动作?动作是预构建的可复用代码步骤,覆盖 Pipedream 1,000 多个 API 集成中的常见操作,例如发送邮件或在 Google Sheet 中添加一行数据;你也可以把自己的动作发布给社区。
什么是目标?目标封装了连接、批处理和投递逻辑,用于把工作流事件发送到 Amazon S3、Snowflake、HTTP、邮件或 SSE 等目标。
Pipedream 免费吗?免费。它提供慷慨的免费套餐,个人开发者在使用限额内无需付费;付费套餐则取消这些限制。
Size
682.7 MB
Stars
11.8K
Updated
CommitOct 16
Age
6y
Commits · 90 Days