diff --git a/sources/platform/integrations/index.mdx b/sources/platform/integrations/index.mdx index 6e8d8246b9..24607f4780 100644 --- a/sources/platform/integrations/index.mdx +++ b/sources/platform/integrations/index.mdx @@ -136,6 +136,12 @@ If you use one of the main integration platforms, Apify's support is here for yo imageUrl="/img/platform/integrations/kestra.svg" smallImage /> + + +## 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). diff --git a/static/img/platform/integrations/pipedream.png b/static/img/platform/integrations/pipedream.png new file mode 100644 index 0000000000..ee35a8e77c Binary files /dev/null and b/static/img/platform/integrations/pipedream.png differ