Pipedream

https://pipedream.com/docs
Admin
Pipedream is a serverless platform for building and automating workflows, offering thousands of...
Tokens:770,474
Snippets:6,047
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### README.md example with subheadings

Source: https://pipedream.com/docs/components/contributing/guidelines

Example README.md with subheadings under the top-level headings. Only the top-level headings Overview, Getting Started, and Troubleshooting appear on the App Marketplace page; other headings are ignored.

```markdown
# Overview

## Limitations

Perhaps there are some limitations about the API that users should know about.

# Example Use Cases

1. Sync data in real time
2. Automate tedious actions
3. Introduce A.I. into the workflow

# Getting Started

## Generating an API Key

Instructions on how to generate an API key from within the service's dashboard.

# Troubleshooting

## Required OAuth Scopes

Please take note, you'll need to have sufficient privileges in order to complete
authentication.
```

--------------------------------

### Basic source scaffolding

Source: https://pipedream.com/docs/components/contributing/sources-quickstart

Initial component structure with a name, description, and an empty async run() method. This is the starting point for the RSS source example.

```javascript
export default {
  name: "Source Demo",
  description: "This is a demo source",
  async run() {},
};

```

--------------------------------

### Retrieve project info with Go HTTP client

Source: https://pipedream.com/docs/connect/api-reference/get-project-info

Use this Go example to make a raw HTTP GET request to the Pipedream Connect API. It sets the required headers and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pipedream.com/v1/connect/{project_id}/projects/info"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-pd-environment", "<x-pd-environment>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### pd init connect

Source: https://pipedream.com/docs/cli/reference

Runs the Connect quickstart to set up a new Connect project. Interactive command that walks through creating a project, setting up an OAuth client, and choosing a demo app. Automatically creates a `.env` file with OAuth client credentials and project ID.

```bash
pd init connect
```

--------------------------------

### Initialize a Connect project

Source: https://pipedream.com/docs/connect/quickstart

Runs the Connect initialization command. Walks through creating a project, setting up an OAuth client, and choosing a demo app.

```bash
pd init connect

```

--------------------------------

### Multiple add-package comments for google-auth and google-cloud-compute

Source: https://pipedream.com/docs/workflows/building-workflows/code/python/import-mappings

When using multiple packages that need magic comments, place all `add-package` comments at the start of the code. This example installs `google-auth` and `google-cloud-compute` and imports `service_account` and `compute_v1`.

```python
# pipedream add-package google-auth
# pipedream add-package google-cloud-compute
from google.oauth2 import service_account
from google.cloud import compute_v1

```

--------------------------------

### Install google-cloud-bigquery with add-package

Source: https://pipedream.com/docs/workflows/building-workflows/code/python/import-mappings

Use the `add-package` comment above imports to install a package whose name differs from its import name. This example installs `google-cloud-bigquery` and imports `bigquery` from `google.cloud`.

```python
# pipedream add-package google-cloud-bigquery
from google.cloud import bigquery

```

--------------------------------

### Start the demo app

Source: https://pipedream.com/docs/connect/quickstart

Starts the demo app after initialization. Requires the project name from the initialization step.

```bash
cd your-project-name
npm run dev

```

--------------------------------

### GET deployed trigger in Go

Source: https://pipedream.com/docs/connect/api-reference/get-deployed-trigger

Use this Go example to make a GET request to the deployed-triggers endpoint. It sets the required headers and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pipedream.com/v1/connect/{project_id}/deployed-triggers/{trigger_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-pd-environment", "<x-pd-environment>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Example: deploy source from raw GitHub URL with pd deploy

Source: https://pipedream.com/docs/llms-full.txt

Example of deploying a source from a raw GitHub URL using the pd deploy command.

```bash
pd deploy https://raw.githubusercontent.com/PipedreamHQ/pipedream/master/components/http/sources/new-requests/new-requests.js
```

--------------------------------

### 200 response example

Source: https://pipedream.com/docs/connect/api-reference/get-deployed-trigger

Example JSON response for a successful GET request (HTTP 200). It contains the deployed trigger details such as id, component_id, configurable_props, and active status.

```json
{
  "data": {
    "id": "<string>",
    "owner_id": "<string>",
    "component_id": "<string>",
    "configurable_props": [
      {
        "name": "<string>",
        "type": "alert",
        "content": "<string>",
        "label": "<string>",
        "description": "<string>",
        "optional": true,
        "disabled": true,
        "readOnly": true,
        "hidden": true,
        "remoteOptions": true,
        "useQuery": true,
        "reloadProps": true,
        "withLabel": true,
        "alertType": "info"
      }
    ],
    "configured_props": {},
    "active": true,
    "created_at": 123,
    "updated_at": 123,
    "name": "<string>",
    "name_slug": "<string>",
    "type": "DeployedComponent",
    "component_key": "<string>",
    "callback_observations": "<unknown>",
    "emit_on_deploy": true,
    "webhook_signing_key": "<string>"
  }
}
```

--------------------------------

### Example: UI URL to deploy source from raw GitHub URL

Source: https://pipedream.com/docs/llms-full.txt

Example of a UI URL to deploy a source from a raw GitHub URL.

```javascript
https://pipedream.com/sources?action=create&url=https%3A%2F%2Fraw.githubusercontent.com%2FPipedreamHQ%2Fpipedream%2Fmaster%2Fcomponents%2Fhttp%2Fhttp.js
```

--------------------------------

### Publish an action with pd publish (example)

Source: https://pipedream.com/docs/components/contributing/api

Example of publishing an action from a file named my-action.js.

```bash
pd publish my-action.js

```

--------------------------------

### GET /v1/connect/{project_id}/accounts

Source: https://pipedream.com/docs/connect/api-reference/list-accounts

This snippet documents the HTTP GET endpoint for listing accounts in a Pipedream project. It includes the endpoint URL, parameters, request example, and response schemas.

```APIDOC
## GET /v1/connect/{project_id}/accounts

### Description
List all accounts for a given project. This endpoint returns a paginated list of connected accounts.

### Method
GET

### Endpoint
`https://api.pipedream.com/v1/connect/{project_id}/accounts`

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The ID of the project.

#### Query Parameters
- **external_user_id** (string) - Optional - Filter accounts by external user ID.
- **oauth_app_id** (string) - Optional - Filter accounts by OAuth app ID.
- **after** (string) - Optional - Cursor for pagination.
- **before** (string) - Optional - Cursor for pagination.
- **limit** (integer) - Optional - Maximum number of items to return.
- **app** (string) - Optional - Filter by app name slug.
- **include_credentials** (boolean) - Optional - Whether to include credentials in the response.

#### Headers
- **Authorization** (string) - Required - Bearer token for authentication.
- **x-pd-environment** (string) - Required - The project environment.

### Request Example
```
curl --request GET \
  --url https://api.pipedream.com/v1/connect/{project_id}/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'x-pd-environment: <x-pd-environment>'
```

### Response
#### Success Response (200)
- **data** (array) - List of account objects.
  - **id** (string) - Account ID.
  - **name** (string) - Account name.
  - **external_id** (string) - External ID.
  - **healthy** (boolean) - Whether the account is healthy.
  - **dead** (boolean) - Whether the account is dead.
  - **app** (object) - App details.
    - **name_slug** (string) - App name slug.
    - **name** (string) - App name.
    - **img_src** (string) - App image source.
    - **custom_fields_json** (string) - Custom fields JSON.
    - **categories** (array) - Categories.
    - **featured_weight** (integer) - Featured weight.
    - **scope_profiles** (array) - Scope profiles.
    - **id** (string) - App ID.
    - **auth_type** (string) - Authentication type.
    - **description** (string) - App description.
  - **created_at** (string) - Creation timestamp.
  - **updated_at** (string) - Last update timestamp.
  - **authorized_scopes** (array) - Authorized scopes.
  - **credentials** (object) - Credentials (if included).
    - **oauth_client_id** (string) - OAuth client ID.
    - **oauth_access_token** (string) - OAuth access token.
    - **oauth_refresh_token** (string) - OAuth refresh token.
    - **oauth_uid** (string) - OAuth UID.
    - **oauth_signer_uri** (string) - OAuth signer URI.
  - **expires_at** (string) - Expiration timestamp.
  - **error** (string) - Error message.
  - **last_refreshed_at** (string) - Last refresh timestamp.
  - **next_refresh_at** (string) - Next refresh timestamp.
- **page_info** (object) - Pagination information.
  - **count** (integer) - Number of items in this page.
  - **total_count** (integer) - Total number of items.
  - **start_cursor** (string) - Start cursor.
  - **end_cursor** (string) - End cursor.

#### Response Example
```
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "external_id": "<string>",
      "healthy": true,
      "dead": true,
      "app": {
        "name_slug": "<string>",
        "name": "<string>",
        "img_src": "<string>",
        "custom_fields_json": "<string>",
        "categories": [
          "<string>"
        ],
        "featured_weight": 123,
        "scope_profiles": [
          {
            "name": "read_only",
            "scopes": [
              "<string>"
            ]
          }
        ],
        "id": "<string>",
        "auth_type": "keys",
        "description": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "authorized_scopes": [
        "<string>"
      ],
      "credentials": {
        "oauth_client_id": "<string>",
        "oauth_access_token": "<string>",
        "oauth_refresh_token": "<string>",
        "oauth_uid": "<string>",
        "oauth_signer_uri": "<string>"
      },
      "expires_at": "2023-11-07T05:31:56Z",
      "error": "<string>",
      "last_refreshed_at": "2023-11-07T05:31:56Z",
      "next_refresh_at": "2023-11-07T05:31:56Z"
    }
  ],
  "page_info": {
    "count": 10,
    "total_count": 120,
    "start_cursor": "<string>",
    "end_cursor": "<string>"
  }
}
```

#### Error Response (429)
- **error** (string) - Error message.

#### Error Example
```
{
  "error": "Throttled"
}
```
```

--------------------------------

### Example: deploy my-source.js with pd deploy

Source: https://pipedream.com/docs/llms-full.txt

Example of deploying a source file named my-source.js using the pd deploy command.

```bash
pd deploy my-source.js
```

--------------------------------

### Deploy Hello World source with pd dev

Source: https://pipedream.com/docs/components/contributing/sources-quickstart

Deploys and runs the Hello World source in development mode.

```bash
pd dev source.js

```

--------------------------------

### Set OpenAI API key

Source: https://pipedream.com/docs/connect/mcp/ai-frameworks/openai

Set the OpenAI API key as an environment variable before using Pipedream MCP with OpenAI. Other environment variables are covered in the setup guide.

```bash
OPENAI_API_KEY=your_openai_api_key

```

--------------------------------

### CLI output after publishing

Source: https://pipedream.com/docs/components/contributing/actions-quickstart

Example output from the CLI after publishing, showing the action key, version, and timestamp.

```text
sc_ZriKEn  Action Demo                             0.0.3    1 second ago         action_demo

```

--------------------------------

### List Deployed Triggers with Go HTTP Client

Source: https://pipedream.com/docs/connect/api-reference/list-deployed-triggers

Use this Go example to make a GET request to the deployed-triggers endpoint. It sets the required headers and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pipedream.com/v1/connect/{project_id}/deployed-triggers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-pd-environment", "<x-pd-environment>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Database schema response example

Source: https://pipedream.com/docs/connect/components/actions

Example response from `configureProps` showing the `context.dbInfo` object with schema details for the `products` table, including column names, data types, nullability, and defaults.

```json
{
  "context": {
    "dbInfo": {
      "products": {
        "metadata": {},
        "schema": {
          "id": {
            "tableName": "products",
            "columnName": "id",
            "isNullable": "NO",
            "dataType": "integer",
            "columnDefault": "nextval('products_id_seq'::regclass)"
          },
          "name": {
            "tableName": "products",
            "columnName": "name",
            "isNullable": "NO",
            "dataType": "character varying",
            "columnDefault": null
          },
          "description": {
            "tableName": "products",
            "columnName": "description",
            "isNullable": "YES",
            "dataType": "text",
            "columnDefault": null
          },
          "price": {
            "tableName": "products",
            "columnName": "price",
            "isNullable": "NO",
            "dataType": "numeric",
            "columnDefault": null
          },
          "created_at": {
            "tableName": "products",
            "columnName": "created_at",
            "isNullable": "YES",
            "dataType": "timestamp with time zone",
            "columnDefault": "CURRENT_TIMESTAMP"
          }
        }
      }
    }
  }
}

```

--------------------------------

### Action component with empty run()

Source: https://pipedream.com/docs/components/contributing/actions-quickstart

Initial action component after removing the axios import and clearing the run() function from the previous example. This is the starting point for adding managed auth.

```javascript
export default {
  name: "Action Demo",
  description: "This is a demo action",
  key: "action_demo",
  version: "0.0.3",
  type: "action",
  async run() {},
};

```

--------------------------------

### pd init action

Source: https://pipedream.com/docs/cli/reference

Creates a new directory and a component action from a template.

```bash
# Creates add-new-event/ directory and add-new-event.mjs file
pd init action add-new-event
```

--------------------------------

### Retrieve Component with Go HTTP Request

Source: https://pipedream.com/docs/connect/api-reference/retrieve-component

Use this Go example to retrieve a component by making a GET request to the Pipedream API. Set the required headers and print the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pipedream.com/v1/connect/{project_id}/components/{component_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-pd-environment", "<x-pd-environment>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### List Users with Go HTTP Request

Source: https://pipedream.com/docs/connect/api-reference/list-users

Use this Go example to make a GET request to the Pipedream Connect users endpoint. It sets the required headers and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pipedream.com/v1/connect/{project_id}/users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-pd-environment", "<x-pd-environment>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Action output example

Source: https://pipedream.com/docs/connect/components/actions

Example response from running the action, showing the exports, observations, and return value. The response includes a summary and a list of commits.

```json
{
  "exports": {
    "$summary": "Retrieved 1 commit"
  },
  "os": [],
  "ret": [
    {
      "id": "387262aea5d4a6920ac76c1e202bc9fd0841fea5",
      "short_id": "387262ae",
      "created_at": "2023-05-03T03:03:25.000+00:00",
      "parent_ids": [],
      "title": "Initial commit",
      "message": "Initial commit",
      "author_name": "Jay Vercellone",
      "author_email": "nope@pipedream.com",
      "authored_date": "2023-05-03T03:03:25.000+00:00",
      "committer_name": "Jay Vercellone",
      "committer_email": "nope@pipedream.com",
      "committed_date": "2023-05-03T03:03:25.000+00:00",
      "trailers": {},
      "extended_trailers": {},
      "web_url": "https://gitlab.com/jverce/foo-massive-10231-1/-/commit/387262aea5d4a6920ac76c1e202bc9fd0841fea5"
    }
  ]
}
```

--------------------------------

### Retrieve Trigger with Go HTTP Client

Source: https://pipedream.com/docs/connect/api-reference/retrieve-trigger

Use this Go example to retrieve a trigger via the REST API. It constructs an HTTP GET request with the required headers and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pipedream.com/v1/connect/{project_id}/triggers/{component_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-pd-environment", "<x-pd-environment>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Source deployment response example

Source: https://pipedream.com/docs/connect/components/triggers

Example response from a successful source deployment. Contains the source ID, owner ID, component ID, configurable props, configured props, and timestamps.

```json
{
  "data": {
    "id": "dc_dAuGmW7",
    "owner_id": "exu_oedidz",
    "component_id": "sc_3vijzQr",
    "configurable_props": [
      {
        "name": "gitlab",
        "type": "app",
        "app": "gitlab"
      },
      {
        "name": "db",
        "type": "$.service.db"
      },
      {
        "name": "http",
        "type": "$.interface.http",
        "customResponse": true
      },
      {
        "name": "projectId",
        "type": "integer",
        "label": "Project ID",
        "description": "The project ID, as displayed in the main project page",
        "remoteOptions": true
      }
    ],
    "configured_props": {
      "gitlab": {
        "authProvisionId": "apn_kVh9AoD"
      },
      "db": {
        "type": "$.service.db"
      },
      "http": {
        "endpoint_url": "https://xxxxxxxxxx.m.pipedream.net"
      },
      "projectId": 45672541
    },
    "active": true,
    "created_at": 1734028283,
    "updated_at": 1734028283,
    "name": "My first project - exu_oedidz",
    "name_slug": "my-first-project---exu-oedidz-2"
  }
}
```

--------------------------------

### Go Request Example

Source: https://pipedream.com/docs/connect/api-reference/list-accounts-for-external-user

Sends a GET request to the Pipedream Connect API using Go's net/http package. The request includes the x-pd-environment and Authorization headers, and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pipedream.com/v1/connect/{project_id}/users/{external_user_id}/accounts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-pd-environment", "<x-pd-environment>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

```

--------------------------------

### pd init app

Source: https://pipedream.com/docs/cli/reference

Generates a new app file from a template. Creates a directory and an app file.

```bash
# Creates google_calendar/ directory and google_calendar.mjs file
pd init app google_calendar
```

--------------------------------

### Use environment variable for API key authentication

Source: https://pipedream.com/docs/workflows/building-workflows/code/python

Use an environment variable to authenticate an API request by passing it in the Authorization header. This example uses the requests library to make a GET request to Airtable.

```python
import requests
import os
 
def handler(pd: "pipedream"):
  token = os.environ["AIRTABLE_API_KEY"]
 
  url = "https://api.airtable.com/v0/your-airtable-base/your-table"
 
  headers = { "Authorization": f"Bearer {token}"}
  r = requests.get(url, headers=headers)
 
  print(r.text)

```

--------------------------------

### Make a GET request with curl

Source: https://pipedream.com/docs/workflows/building-workflows/code/bash

Use curl with the --silent flag to suppress diagnostic output and store the response in a variable. The example fetches the current weather in San Francisco and echoes the result.

```bash
# Get the current weather in San Francisco
WEATHER=`curl --silent https://wttr.in/San\ Francisco\?format=3`
 
echo $WEATHER
# Produces:
# San Francisco: 🌫  +48°F

```
Tokens:
Raw