├── .circleci └── config.yml ├── .gitignore ├── README.md ├── docs ├── .vuepress │ ├── components │ │ └── Footer.vue │ ├── config.js │ ├── enhanceApp.js │ ├── public │ │ ├── favicon.ico │ │ └── pipedream.svg │ └── styles │ │ └── index.styl ├── README.md ├── api │ ├── auth │ │ └── README.md │ ├── overview │ │ └── README.md │ ├── rest │ │ ├── README.md │ │ └── rss │ │ │ └── README.md │ └── sse │ │ └── README.md ├── apps │ ├── all-apps │ │ └── README.md │ ├── discord │ │ ├── README.md │ │ └── images │ │ │ ├── cron-scheduler.png │ │ │ ├── discord-bot-actions.png │ │ │ ├── discord-bot.png │ │ │ ├── discord-webhook.png │ │ │ ├── discord_plus_pipedream.png │ │ │ └── send-message-to-channel.png │ ├── intercom │ │ └── README.md │ ├── servicenow │ │ ├── README.md │ │ └── images │ │ │ ├── oauth-app-config.png │ │ │ ├── oauth-validator-config.png │ │ │ └── pipedream-app-config.png │ ├── slack │ │ └── README.md │ ├── twitter │ │ ├── README.md │ │ └── images │ │ │ ├── twitter-app-actions.png │ │ │ ├── twitter-pipedream-label.png │ │ │ └── twitter-post-tweet.png │ ├── zoho-books │ │ └── README.md │ └── zoom │ │ ├── README.md │ │ └── images │ │ ├── connect-zoom-account.png │ │ ├── event-sources.png │ │ ├── recording-completed-source.png │ │ ├── sse.png │ │ ├── workflow.png │ │ ├── zoom-apps-from-apps-page.png │ │ ├── zoom-apps.png │ │ ├── zoom-events-dropdown.png │ │ └── zoom-sources-list.png ├── cli │ ├── install │ │ └── README.md │ ├── login │ │ └── README.md │ └── reference │ │ └── README.md ├── connected-accounts │ ├── README.md │ └── images │ │ ├── add-new-app.png │ │ ├── api-key.png │ │ ├── connect-existing-account.png │ │ ├── manage-connected-account.png │ │ ├── search-for-slack.png │ │ ├── slack-connect-account.png │ │ └── slack-token.png ├── cron │ ├── README.md │ └── images │ │ ├── cron-dollar-event.png │ │ └── cron-scheduler-source.png ├── destinations │ ├── README.md │ ├── email │ │ ├── README.md │ │ └── images │ │ │ └── email-destination.png │ ├── http │ │ ├── README.md │ │ └── images │ │ │ ├── http-request-response.png │ │ │ ├── new-code-step.png │ │ │ ├── new-code.png │ │ │ ├── three-http-requests.png │ │ │ ├── webhook-action-params.png │ │ │ ├── webhook-action.png │ │ │ ├── webhook-dest-params.png │ │ │ └── webhook-destination.png │ ├── images │ │ ├── conditional-payload-expression.png │ │ ├── dollar-event-body-payload.png │ │ ├── dollar-event-payload.png │ │ ├── email-payload.png │ │ ├── new-code-step.png │ │ ├── new-code.png │ │ ├── webhook-action-params.png │ │ └── webhook-action.png │ ├── s3 │ │ ├── README.md │ │ └── images │ │ │ ├── s3-action.png │ │ │ └── s3-dest-params.png │ ├── snowflake │ │ ├── README.md │ │ └── images │ │ │ ├── json-in-snowflake.png │ │ │ ├── run-node-js-code.png │ │ │ ├── snowflake-action-params.png │ │ │ └── snowflake-action.png │ ├── sql │ │ ├── README.md │ │ └── images │ │ │ ├── download-button.png │ │ │ ├── invalid-table-name.png │ │ │ ├── send-data-to-sql-table.png │ │ │ ├── sql-actions.png │ │ │ ├── sql-by-pipedream.png │ │ │ ├── sql-destination-details.png │ │ │ ├── sql-destination.png │ │ │ ├── sql-tab.png │ │ │ ├── sql-ui.png │ │ │ ├── star-wars-struct.png │ │ │ ├── test-table-schema.png │ │ │ ├── ts-number.png │ │ │ └── ts-string.png │ └── sse │ │ ├── README.md │ │ └── images │ │ ├── new-code-step.png │ │ ├── new-code.png │ │ └── pipeline-id.png ├── environment-variables │ ├── README.md │ └── images │ │ ├── add-new-env-var.png │ │ ├── add-remove-env-var.png │ │ ├── edit-environment.png │ │ ├── env-var-error.png │ │ ├── env-vars.gif │ │ └── params-hamburger-menu.png ├── event-sources │ ├── README.md │ ├── github │ │ └── README.md │ ├── http │ │ └── README.md │ ├── logs │ │ └── README.md │ ├── public-streams │ │ └── README.md │ └── rss │ │ └── README.md ├── limits │ ├── README.md │ └── images │ │ ├── timeout-err-cell.png │ │ └── timeout-err-inspector.png ├── new-feature-or-bug │ └── README.md ├── notebook │ ├── README.md │ ├── actions │ │ ├── README.md │ │ └── images │ │ │ ├── new-cell.png │ │ │ ├── new-destination-type.png │ │ │ ├── new-destination.png │ │ │ ├── webhook-action-params.png │ │ │ └── webhook-action.png │ ├── code │ │ ├── README.md │ │ └── images │ │ │ ├── console-log-error.png │ │ │ ├── dollar-end.png │ │ │ ├── exception-in-code-cell.png │ │ │ ├── exception.png │ │ │ ├── new-button.png │ │ │ ├── new-code-step.png │ │ │ └── syntax-error.png │ ├── destinations │ │ ├── README.md │ │ ├── email │ │ │ ├── README.md │ │ │ └── images │ │ │ │ └── email-destination.png │ │ ├── http │ │ │ ├── README.md │ │ │ └── images │ │ │ │ ├── http-request-response.png │ │ │ │ ├── new-code-step.png │ │ │ │ ├── new-code.png │ │ │ │ ├── three-http-requests.png │ │ │ │ ├── webhook-action-params.png │ │ │ │ ├── webhook-action.png │ │ │ │ ├── webhook-dest-params.png │ │ │ │ └── webhook-destination.png │ │ ├── images │ │ │ ├── conditional-payload-expression.png │ │ │ ├── dollar-event-body-payload.png │ │ │ ├── dollar-event-payload.png │ │ │ ├── email-payload.png │ │ │ ├── new-code-step.png │ │ │ ├── new-code.png │ │ │ ├── webhook-action-params.png │ │ │ └── webhook-action.png │ │ ├── s3 │ │ │ ├── README.md │ │ │ └── images │ │ │ │ ├── s3-action.png │ │ │ │ └── s3-dest-params.png │ │ ├── snowflake │ │ │ ├── README.md │ │ │ └── images │ │ │ │ ├── json-in-snowflake.png │ │ │ │ ├── snowflake-action-params.png │ │ │ │ └── snowflake-action.png │ │ └── sse │ │ │ ├── README.md │ │ │ └── images │ │ │ ├── new-code-step.png │ │ │ ├── new-code.png │ │ │ └── pipeline-id.png │ ├── dollar-context │ │ └── README.md │ ├── dollar-event │ │ ├── README.md │ │ └── images │ │ │ ├── cmd-click-to-get-path.png │ │ │ ├── complex-dollar-event.png │ │ │ ├── diff.png │ │ │ └── dollar-event.png │ ├── fork │ │ ├── README.md │ │ └── images │ │ │ ├── fork-of.png │ │ │ └── fork.png │ ├── images │ │ ├── active.png │ │ ├── archive-workflow.png │ │ ├── inactive.png │ │ ├── list-of-active-inactive-workflows.png │ │ ├── my-pipelines.png │ │ ├── new-pipeline-url.png │ │ ├── pipeline-version.png │ │ ├── pipeline.png │ │ ├── text-description.png │ │ └── workflow-url.png │ ├── inspector │ │ ├── README.md │ │ └── images │ │ │ ├── dest-field.png │ │ │ ├── dollar-end.png │ │ │ ├── dollar-event.png │ │ │ ├── duration.png │ │ │ ├── edit-test-event.png │ │ │ ├── event-date-grouping.png │ │ │ ├── exception.png │ │ │ ├── inspector.png │ │ │ ├── new-old-events.png │ │ │ ├── paused-event-count.png │ │ │ ├── replay.png │ │ │ ├── search-box.png │ │ │ ├── send-test-event-button.png │ │ │ └── version.png │ ├── observability │ │ └── README.md │ ├── sources │ │ ├── README.md │ │ └── images │ │ │ ├── cron-scheduler-source.png │ │ │ ├── github-source.png │ │ │ ├── list-of-sources.png │ │ │ ├── proto.png │ │ │ └── syntax-error.png │ └── sql │ │ ├── README.md │ │ └── images │ │ ├── download-button.png │ │ ├── invalid-table-name.png │ │ ├── sql-destination-details.png │ │ ├── sql-destination.png │ │ ├── sql-tab.png │ │ ├── sql-ui.png │ │ ├── star-wars-struct.png │ │ ├── test-table-schema.png │ │ ├── ts-number.png │ │ └── ts-string.png ├── pricing │ └── README.md ├── public-workflows │ ├── README.md │ └── images │ │ ├── toggle-workflow-visibility.png │ │ └── workflow-visibility.png ├── removed-features │ └── dollar-variables │ │ └── README.md ├── security │ └── README.md ├── sign-up │ ├── README.md │ └── images │ │ ├── choose-username.png │ │ └── idps.png ├── snippets │ └── public-node-ips ├── status │ └── README.md ├── support │ ├── README.md │ └── images │ │ └── chat.png ├── what-is-pipedream │ └── README.md ├── workflows │ ├── README.md │ ├── copy │ │ └── README.md │ ├── error-handling │ │ └── global-error-workflow │ │ │ ├── README.md │ │ │ └── images │ │ │ ├── error-event.png │ │ │ ├── global-error-workflow.png │ │ │ └── workflow-error-settings.png │ ├── events │ │ ├── README.md │ │ ├── images │ │ │ ├── cmd-click-to-get-path.png │ │ │ ├── complex-dollar-event.png │ │ │ ├── diff.png │ │ │ └── dollar-event.png │ │ ├── inspect │ │ │ ├── README.md │ │ │ └── images │ │ │ │ ├── dest-field.png │ │ │ │ ├── dollar-end.png │ │ │ │ ├── dollar-event.png │ │ │ │ ├── duration.png │ │ │ │ ├── edit-test-event.png │ │ │ │ ├── event-date-grouping.png │ │ │ │ ├── exception.png │ │ │ │ ├── inspector.png │ │ │ │ ├── new-old-events.png │ │ │ │ ├── paused-event-count.png │ │ │ │ ├── replay.png │ │ │ │ ├── search-box.png │ │ │ │ ├── send-test-event-button.png │ │ │ │ ├── the-inspector.png │ │ │ │ └── version.png │ │ ├── replay │ │ │ ├── README.md │ │ │ └── images │ │ │ │ ├── dest-field.png │ │ │ │ ├── dollar-end.png │ │ │ │ ├── dollar-event.png │ │ │ │ ├── duration.png │ │ │ │ ├── edit-test-event.png │ │ │ │ ├── event-date-grouping.png │ │ │ │ ├── exception.png │ │ │ │ ├── inspector.png │ │ │ │ ├── new-old-events.png │ │ │ │ ├── paused-event-count.png │ │ │ │ ├── replay.png │ │ │ │ ├── search-box.png │ │ │ │ ├── send-test-event-button.png │ │ │ │ └── version.png │ │ └── test │ │ │ ├── README.md │ │ │ └── images │ │ │ ├── dest-field.png │ │ │ ├── dollar-end.png │ │ │ ├── dollar-event.png │ │ │ ├── duration.png │ │ │ ├── edit-test-event.png │ │ │ ├── event-date-grouping.png │ │ │ ├── exception.png │ │ │ ├── inspector.png │ │ │ ├── new-old-events.png │ │ │ ├── paused-event-count.png │ │ │ ├── replay.png │ │ │ ├── search-box.png │ │ │ ├── send-test-event-button.png │ │ │ └── version.png │ ├── fork │ │ └── README.md │ ├── images │ │ ├── active.png │ │ ├── archive-workflow.png │ │ ├── inactive.png │ │ ├── list-of-active-inactive-workflows.png │ │ ├── my-pipelines.png │ │ ├── new-pipeline-url.png │ │ ├── pipeline-version.png │ │ ├── pipeline.png │ │ ├── text-description.png │ │ └── workflow-url.png │ ├── managing │ │ ├── README.md │ │ └── images │ │ │ ├── active.png │ │ │ ├── archive-workflow.png │ │ │ ├── inactive.png │ │ │ ├── list-of-active-inactive-workflows.png │ │ │ ├── my-pipelines.png │ │ │ ├── new-pipeline-url.png │ │ │ ├── pipeline-version.png │ │ │ ├── pipeline.png │ │ │ ├── share-button.png │ │ │ ├── text-description.png │ │ │ ├── workflow-url.png │ │ │ └── workflow-visibility.png │ ├── rate-limiting │ │ └── README.md │ ├── settings │ │ ├── README.md │ │ └── images │ │ │ ├── shared-with-me.png │ │ │ └── workflow-settings.png │ └── steps │ │ ├── README.md │ │ ├── actions │ │ ├── README.md │ │ └── images │ │ │ ├── http-example.png │ │ │ ├── new-cell.png │ │ │ ├── new-destination-type.png │ │ │ ├── new-destination.png │ │ │ ├── send-http-request.png │ │ │ ├── send-slack-message.png │ │ │ ├── webhook-action-params.png │ │ │ └── webhook-action.png │ │ ├── code │ │ ├── README.md │ │ ├── auth │ │ │ ├── README.md │ │ │ └── images │ │ │ │ ├── auths-property.png │ │ │ │ ├── run-node-js-code-with-slack.png │ │ │ │ ├── search-for-slack.png │ │ │ │ ├── slack-test-request.png │ │ │ │ └── slack-token.png │ │ ├── images │ │ │ ├── console-log-error.png │ │ │ ├── dollar-end.png │ │ │ ├── exception-in-code-cell.png │ │ │ ├── exception.png │ │ │ ├── new-button.png │ │ │ ├── new-code-step.png │ │ │ ├── syntax-error.png │ │ │ └── this-checkpoint-observability.png │ │ ├── nodejs │ │ │ ├── http-requests │ │ │ │ └── README.md │ │ │ └── working-with-files │ │ │ │ └── README.md │ │ └── state │ │ │ └── README.md │ │ ├── images │ │ ├── active.png │ │ ├── archive-workflow.png │ │ ├── edit-params-schema.png │ │ ├── inactive.png │ │ ├── list-of-active-inactive-workflows.png │ │ ├── my-pipelines.png │ │ ├── new-pipeline-url.png │ │ ├── new-step-name.png │ │ ├── param-visibility.png │ │ ├── params-foo.png │ │ ├── params-name.png │ │ ├── pipeline-version.png │ │ ├── pipeline.png │ │ ├── step-name.png │ │ ├── text-description.png │ │ └── workflow-url.png │ │ └── triggers │ │ ├── README.md │ │ └── images │ │ ├── cron-scheduler-source.png │ │ ├── github-source.png │ │ ├── google-calendar-triggers.png │ │ ├── image_form_data.png │ │ ├── list-of-sources.png │ │ ├── proto.png │ │ └── syntax-error.png └── your-first-workflow │ ├── README.md │ └── images │ ├── console-log-test.png │ ├── create-rb.png │ ├── destination-details.png │ ├── empty-title-description.png │ ├── event-body.png │ ├── event-headers-expanded.png │ ├── event-headers.png │ ├── event-new-key.png │ ├── example-event.png │ ├── first-pipeline-request.png │ ├── hurlit.png │ ├── inspector-destinations.png │ ├── lodash-mean.png │ ├── new-code-cell.png │ ├── new-destination.png │ ├── new-pipeline-url.png │ ├── new-pipeline.png │ ├── new-step.png │ ├── new-title-description.png │ ├── new-url.png │ ├── rb-url.png │ ├── response-from-destination.png │ ├── save.png │ ├── sent-to-destination.png │ ├── source.png │ ├── sql-destination-details.png │ └── sql-tab.png ├── package-lock.json ├── package.json └── yarn.lock /.circleci/config.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | jobs: 3 | deploy: 4 | docker: 5 | - image: circleci/node:10 6 | working_directory: ~/git 7 | 8 | steps: 9 | - run: 10 | name: Install Python & Pip 11 | command: sudo apt-get update && sudo apt-get install python-pip python-dev 12 | 13 | - run: 14 | name: Install AWSCli 15 | command: sudo pip install awscli 16 | 17 | - checkout 18 | 19 | - run: 20 | name: Install dependencies 21 | command: yarn install 22 | 23 | - run: 24 | name: Build Docs 25 | command: yarn docs:build 26 | 27 | - run: 28 | name: Deploy Docs to S3 29 | command: aws s3 sync docs/.vuepress/dist/ $DOCS_S3_URI --delete --acl public-read 30 | 31 | - run: 32 | name: Invalidate Cloudfront cache 33 | command: aws cloudfront create-invalidation --distribution-id $PIPEDREAM_CLOUDFRONT_DISTRIBUTION_ID --paths "/*" 34 | 35 | workflows: 36 | version: 2 37 | prod: 38 | jobs: 39 | - deploy: 40 | context: pipedream-docs 41 | filters: 42 | branches: 43 | only: 44 | - master 45 | stage: 46 | jobs: 47 | - deploy: 48 | context: pipedream-docs-dev 49 | filters: 50 | branches: 51 | only: 52 | - stage.* 53 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | yarn-error.log 2 | node_modules 3 | docs/.vuepress/dist/ 4 | .DS_Store 5 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Pipedream Docs 2 | 3 | These docs have been permanently moved to the [PipedreamHQ/pipedream](https://github.com/PipedreamHQ/pipedream) repo, in the `docs/` directory. Please refer to that repo for the most up-to-date content! 4 | 5 | This repo will be permanently deleted on 2020-09-01. 6 | -------------------------------------------------------------------------------- /docs/.vuepress/components/Footer.vue: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/.vuepress/config.js: -------------------------------------------------------------------------------- 1 | const path = require("path"); 2 | const webpack = require("webpack"); 3 | 4 | module.exports = { 5 | title: "Docs", 6 | head: [["link", { rel: "icon", href: "/favicon.ico" }]], 7 | description: "Pipedream Documentation - Integrate your apps, data and APIs", 8 | base: "/", 9 | themeConfig: { 10 | algolia: { 11 | apiKey: "1e23962724b59d018bdedc0f5a214ce5", 12 | indexName: "pipedream", 13 | }, 14 | logo: "/pipedream.svg", 15 | nav: [ 16 | { 17 | text: "Slack", 18 | link: "https://pipedream.com/community", 19 | }, 20 | { 21 | text: "Support", 22 | link: "/support/", 23 | }, 24 | { 25 | text: "pipedream.com", 26 | link: "https://pipedream.com/", 27 | }, 28 | ], 29 | repo: "PipedreamHQ/docs", 30 | 31 | // Optional options for generating "Edit this page" link 32 | 33 | // if your docs are not at the root of the repo: 34 | docsDir: "docs", 35 | editLinks: true, 36 | // custom text for edit link. Defaults to "Edit this page" 37 | editLinkText: "Help us improve this page! Submit an edit on Github", 38 | sidebar: [ 39 | "/", 40 | "/support/", 41 | "/sign-up/", 42 | { 43 | title: "Getting Started", 44 | collapsable: false, 45 | children: ["/workflows/", "/your-first-workflow/"], 46 | }, 47 | { 48 | title: "Workflow Steps", 49 | collapsable: false, 50 | children: [ 51 | "/workflows/steps/", 52 | "/workflows/steps/triggers/", 53 | "/workflows/steps/code/", 54 | "/workflows/steps/code/state/", 55 | "/workflows/steps/code/nodejs/http-requests/", 56 | "/workflows/steps/code/nodejs/working-with-files/", 57 | "/workflows/steps/actions/", 58 | ], 59 | }, 60 | { 61 | title: "Workflow Events", 62 | collapsable: false, 63 | children: [ 64 | "/workflows/events/", 65 | "/workflows/events/inspect/", 66 | "/workflows/events/replay/", 67 | "/workflows/events/test/", 68 | ], 69 | }, 70 | { 71 | title: "Connecting to Apps", 72 | collapsable: false, 73 | children: [ 74 | "/apps/all-apps/", 75 | "/connected-accounts/", 76 | "/workflows/steps/code/auth/", 77 | ], 78 | }, 79 | { 80 | title: "Error Handling", 81 | collapsable: false, 82 | children: ["/workflows/error-handling/global-error-workflow/"], 83 | }, 84 | { 85 | title: "Managing Workflows", 86 | collapsable: false, 87 | children: [ 88 | "/workflows/copy/", 89 | "/workflows/managing/", 90 | "/workflows/settings/", 91 | "/public-workflows/", 92 | "/environment-variables/", 93 | ], 94 | }, 95 | { 96 | title: "Event Sources", 97 | collapsable: false, 98 | children: ["/event-sources/", "/event-sources/logs/"], 99 | }, 100 | { 101 | title: "CLI", 102 | collapsable: false, 103 | children: ["/cli/install/", "/cli/login/", "/cli/reference/"], 104 | }, 105 | { 106 | title: "APIs", 107 | collapsable: false, 108 | children: [ 109 | "/api/overview/", 110 | "/api/auth/", 111 | "/api/rest/", 112 | "/api/rest/rss/", 113 | "/api/sse/", 114 | ], 115 | }, 116 | { 117 | title: "Destinations", 118 | collapsable: false, 119 | children: [ 120 | "/destinations/", 121 | "/destinations/http/", 122 | "/destinations/s3/", 123 | "/destinations/email/", 124 | "/destinations/sql/", 125 | "/destinations/sse/", 126 | ], 127 | }, 128 | { 129 | title: "Integrations", 130 | collapsable: false, 131 | children: [ 132 | "/apps/all-apps/", 133 | "/apps/discord/", 134 | "/apps/intercom/", 135 | "/apps/servicenow/", 136 | "/apps/slack/", 137 | "/apps/twitter/", 138 | "/apps/zoho-books/", 139 | "/apps/zoom/", 140 | ], 141 | }, 142 | "/pricing/", 143 | "/limits/", 144 | "/new-feature-or-bug/", 145 | "/security/", 146 | "/status/", 147 | ], 148 | PIPEDREAM_BASE_URL: "https://pipedream.com", 149 | API_BASE_URL: "https://api.pipedream.com/v1", 150 | SQL_API_BASE_URL: "https://rt.pipedream.com/sql", 151 | PAYLOAD_SIZE_LIMIT: "512KB", 152 | EMAIL_PAYLOAD_SIZE_LIMIT: "256KB", 153 | INSPECTOR_EVENT_LIMIT: "100", 154 | INSPECTOR_EVENT_EXPIRY_DAYS: "30", 155 | NODE_VERSION: "10", 156 | }, 157 | }; 158 | -------------------------------------------------------------------------------- /docs/.vuepress/enhanceApp.js: -------------------------------------------------------------------------------- 1 | import "inter-ui/inter-hinted.css"; 2 | import VueGtm from "vue-gtm"; 3 | 4 | export default ({ 5 | Vue, // the version of Vue being used in the VuePress app 6 | options, // the options for the root Vue instance 7 | router, // the router instance for the app 8 | siteData // site metadata 9 | }) => { 10 | if (typeof window !== "undefined") { 11 | Vue.use(VueGtm, { 12 | id: "GTM-KBDH3DB", 13 | enabled: true, 14 | debug: false, 15 | vueRouter: router 16 | }); 17 | } 18 | }; 19 | -------------------------------------------------------------------------------- /docs/.vuepress/public/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PipedreamHQ/docs/668cb92be35cc71fab22597284625cb7c9c3d227/docs/.vuepress/public/favicon.ico -------------------------------------------------------------------------------- /docs/.vuepress/public/pipedream.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | -------------------------------------------------------------------------------- /docs/.vuepress/styles/index.styl: -------------------------------------------------------------------------------- 1 | body 2 | font-family Inter, sans-serif, Helvetica, Roboto, "Helvetica Neue", Arial, sans-serif 3 | 4 | $hoverColor = #34d28b 5 | $borderColor = #fff 6 | $bgColor = #fff 7 | $sidebarColor = #000 8 | $headerColor = #343c56 9 | $textColor = rgba(0,0,0,.84) 10 | 11 | html, 12 | body, 13 | .navbar, 14 | .sidebar, 15 | .navbar .links, 16 | .theme-container .navbar, 17 | .theme-container .sidebar 18 | background-color $bgColor 19 | 20 | body .content .default 21 | color $textColor 22 | 23 | .nav-item 24 | color: $headerColor 25 | 26 | @media (max-width: 719px) 27 | color $headerColor 28 | 29 | .nav-item a:hover 30 | color: $hoverColor 31 | 32 | @media (max-width: 719px) 33 | color $hoverColor 34 | 35 | .theme-container .navbar img 36 | height 22px 37 | width 144px 38 | padding-top: 0.5em 39 | 40 | div .sidebar-button svg 41 | color: $sidebarColor 42 | 43 | .navbar .site-name 44 | color $sidebarColor 45 | margin-left: -25px 46 | margin-top: 1px -------------------------------------------------------------------------------- /docs/README.md: -------------------------------------------------------------------------------- 1 | --- 2 | prev: false 3 | next: false 4 | --- 5 | 6 | # What is Pipedream? 7 | 8 | Pipedream is an integration platform for developers to build and run [workflows](/workflows/) that integrate apps, data, and APIs — no servers or infrastructure to manage! 9 | 10 | - Develop any workflow, based on any trigger. 11 | - Workflows are code, which you can run for [free](/pricing/). 12 | - No server or cloud resources to manage. 13 | 14 | ### Quickstart 15 | 16 | If you're new to Pipedream, we recommend starting with this [5 minute tutorial](https://pipedream.com/new?appcue=5ec1fd72-798f-4f32-b225-35b94315bf11) to learn how to: 17 | 18 | - Trigger a workflow on HTTP requests 19 | - Retrieve data from an API using Node.js and npm 20 | - Deploy and test your changes. 21 | 22 | If you want to skip the tutorial, just [sign in](/sign-up/) to get started for free! If you have any questions or feedback, [join us on Slack](https://pipedream.com/community/) or [reach out](/support/)! 23 | 24 | 25 | ### No servers or infrastructure to manage 26 | 27 | In other tools, you typically have to setup infrastructure to process events — typically you setup an HTTP endpoint, then run a script on a container, or have to manage a serverless function. This takes time to write and maintain. 28 | 29 | Pipedream is purpose-built for running workflows on event data, so we take care of the infrastructure and boilerplate configuration for you. **Pipedream lets you focus on _what_ you want done, and we take care of _how_ to do it for you.** 30 | 31 | ### Run any Node code 32 | 33 | Write Node.js [code](/workflows/steps/code/) and require npm packages. `event` contains your trigger event data. Exported step data, along with standard output, appears under each code step for inline observability. 34 | 35 | ### Iterate quickly with inline observability, automatic versioning and instant deploys 36 | 37 | See events and debug execution details in real time. Output, errors, timing, and return values appear below each step. Time travel to previous versions of code, at the time the event occurred. 38 | 39 | ### Connect to APIs without writing any code 40 | 41 | [Actions](/workflows/steps/actions/) are pre-defined code steps built by the Pipedream community. Send a message to Slack or Discord, store data in S3 or Snowflake, and more, all without writing any code. 42 | 43 | ### Auth made easy 44 | 45 | Auth apps once, connect to those apps in any workflow. Pipedream supports OAuth and key-based auth, and handles the OAuth flow and token refresh for you. Just link accounts to steps and reference the relevant auth info in code. 46 | 47 | ### It's free! 48 | 49 | We believe anyone should be able to run simple, low-volume workflows at [no cost](/pricing/), sharing their workflows with the public so everyone benefits from the work of others. We also want to foster a positive community where people feel good about sharing their work and where everyone can learn from one another. 50 | -------------------------------------------------------------------------------- /docs/api/auth/README.md: -------------------------------------------------------------------------------- 1 | # Authentication 2 | 3 | [[toc]] 4 | 5 | ## Pipedream API Key 6 | 7 | When you sign up for Pipedream, an API key is automatically generated for your account. You can use this key to authorize requests to the API. 8 | 9 | You'll find this API key in your [Account Settings](https://pipedream.com/settings/account) (**Settings** -> **Account**). 10 | 11 | ## Authorizing API requests 12 | 13 | Pipedream uses [Bearer Authentication](https://oauth.net/2/bearer-tokens/) to authorize your access to the API or SSE event streams. When you make API requests, pass an `Authorization` header of the following format: 14 | 15 | ```text 16 | Authorization: Bearer 17 | ``` 18 | 19 | For example, here's how you can use `cURL` to fetch profile information for the authenticated user: 20 | 21 | ```bash 22 | curl 'https://api.pipedream.com/v1/users/me' \ 23 | -H 'Authorization: Bearer ' 24 | ``` 25 | 26 | ## Using the Pipedream CLI 27 | 28 | You can [link the CLI to your Pipedream account](/cli/login/), which will automatically pass your API key in the `Authorization` header with every API request. 29 | 30 | ## Revoking your API key 31 | 32 | You can revoke your API key in your [Account Settings](https://pipedream.com/settings/account) (**Settings** -> **Account**). Click on the **REVOKE** button directly to the right of your API key. 33 | 34 | This will revoke your original API key, generating a new one. Any API requests made with the original token will yield a `401 Unauthorized` error. 35 | 36 |