-
Notifications
You must be signed in to change notification settings - Fork 182
docs: add Pipedream integration page #2388
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
marcel-rbro
wants to merge
4
commits into
master
Choose a base branch
from
docs/pipedream-integration
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+84
−0
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
b5e3474
docs: add Pipedream integration page
marcel-rbro df0bee5
docs: clarify steps for connecting Apify account in Pipedream integra…
marcel-rbro 2b62df9
Merge branch 'master' into docs/pipedream-integration
marcel-rbro ebdec54
docs: update authentication methods for connecting Apify with Pipedream
marcel-rbro File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
78 changes: 78 additions & 0 deletions
78
sources/platform/integrations/workflows-and-notifications/pipedream.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| --- | ||
| title: Pipedream integration | ||
| description: Connect Apify with Pipedream to automate workflows by running Actors, managing storage, and reacting to Actor or task run events. | ||
| sidebar_label: Pipedream | ||
| sidebar_position: 7 | ||
| slug: /integrations/pipedream | ||
| --- | ||
|
|
||
| import ThirdPartyDisclaimer from '@site/sources/_partials/_third-party-integration.mdx'; | ||
|
|
||
| [Pipedream](https://pipedream.com/) is a workflow automation platform for developers. With the [Apify integration for Pipedream](https://pipedream.com/apps/apify), you can run Actors, manage datasets and key-value stores, and trigger workflows when Actor or task runs finish. | ||
|
|
||
| <ThirdPartyDisclaimer /> | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Before you begin, make sure you have: | ||
|
|
||
| - An [Apify account](https://console.apify.com/) | ||
| - A [Pipedream account](https://pipedream.com/) | ||
|
|
||
| ## Connect Apify with Pipedream | ||
|
|
||
| 1. Log into your Pipedream account and [create a new workflow](https://pipedream.com/docs/workflows). | ||
| 1. [Add an Apify step](https://pipedream.com/docs/workflows/building-workflows/steps) (trigger or action) to your workflow. | ||
| 1. Select **Connect Apify** and authenticate using one of two methods: | ||
| - **API token** - Enter your Apify API token. Find it in [Apify Console](https://console.apify.com/settings/integrations) under **Settings > Integrations**. | ||
| - **OAuth** - Select the **Apify (OAuth)** app and authorize access to your Apify account. | ||
|
|
||
| See [connected accounts](https://pipedream.com/docs/apps/connected-accounts) for more details. | ||
| 1. After connecting, you can use any Apify trigger or action in your workflows. | ||
|
|
||
| ## Use Apify as a trigger | ||
|
|
||
| [Triggers](https://pipedream.com/docs/workflows/building-workflows/triggers) start your Pipedream workflow automatically when an event occurs in Apify. | ||
|
|
||
| 1. [Create a new workflow](https://pipedream.com/docs/workflows) in Pipedream. | ||
| 1. Select **Add Trigger** and search for **Apify**. | ||
| 1. Select the trigger you want to use, e.g. **New Finished Actor Run**. | ||
| 1. Configure the trigger by selecting the Actor or task to monitor. | ||
| 1. Add subsequent steps to process the output. | ||
|
|
||
| ## Use Apify as an action | ||
|
|
||
| [Actions](https://pipedream.com/docs/workflows/building-workflows/actions) let you perform Apify operations as part of a workflow. For example, you can run an Actor and then retrieve its dataset items. | ||
|
|
||
| 1. [Create a new workflow](https://pipedream.com/docs/workflows) in Pipedream with any trigger. | ||
| 1. Click **+** to add a step and search for **Apify**. | ||
| 1. Select the action you want to use, e.g. **Run Actor**. | ||
| 1. Configure the action parameters: | ||
| - Select the Actor from Apify Store or your recently used Actors | ||
| - Provide the Actor input as JSON | ||
| - Set optional parameters such as timeout, memory, and build tag | ||
| 1. Add another Apify step with **Get Dataset Items** to retrieve the Actor's output. | ||
| 1. Add any subsequent steps to process or store the data. | ||
|
|
||
| ## Triggers | ||
|
|
||
| - **New finished Actor run (instant)** - Triggers when a selected Actor run finishes. | ||
| - **New finished task run (instant)** - Triggers when a selected task run finishes. | ||
|
|
||
| ## Actions | ||
|
|
||
| - **Run Actor** - Runs a selected Actor with customizable input and configuration. | ||
| - **Run task** - Runs a selected Actor task and optionally waits for it to finish. | ||
| - **Run task synchronously** - Runs a selected task and returns its dataset items when it finishes. | ||
| - **Scrape single URL** - Runs a scraper on a specified URL and returns its content as HTML. Use this for extracting content from a single page, e.g. in LLM workflows. | ||
| - **Get dataset items** - Retrieves items from a [dataset](/platform/storage/dataset). | ||
| - **Get key-value store record** - Retrieves a record from a [key-value store](/platform/storage/key-value-store). | ||
| - **Set key-value store record** - Creates or updates a record in a [key-value store](/platform/storage/key-value-store). | ||
|
|
||
| ## Resources | ||
|
|
||
| - [Apify integration page on Pipedream](https://pipedream.com/apps/apify) | ||
| - [Pipedream documentation](https://pipedream.com/docs/) | ||
| - [Integration source code on GitHub](https://github.com/PipedreamHQ/pipedream/tree/master/components/apify) | ||
|
|
||
| If you have any questions or need help, reach out on the [Apify developer community on Discord](https://discord.com/invite/jyEM2PRvMU). | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are you sure about html isnt it markdown?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://github.com/PipedreamHQ/pipedream/blob/master/components/apify/actions/scrape-single-url/scrape-single-url.mjs
I got the info from here:
And they actually reference our docs: https://docs.apify.com/sdk/js/docs/guides/crawl-single-url
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, I need to check this one; there may be a wrong description. But it is not problem with this docs.