diff --git a/sources/platform/actors/development/actor_definition/index.md b/sources/platform/actors/development/actor_definition/index.md index 7825e49eee..b04ae93854 100644 --- a/sources/platform/actors/development/actor_definition/index.md +++ b/sources/platform/actors/development/actor_definition/index.md @@ -23,8 +23,8 @@ Actors have the following elements: The documentation and the input/output schemas make it possible for people to easily understand what the Actor does, enter the required inputs both in the user interface or API, and integrate the Actor's results with their other workflows. Actors can easily call and interact with each other, enabling building more complex systems on top of simple ones. -The Apify platform provides an open [API](/api/v2), cron-style [scheduler](../../schedules), [webhooks](../../../integrations/webhooks/index.md), and [integrations](../../integrations) to services such as Zapier or Make, which make it easy for users to integrate Actors with their existing workflows. Anyone is welcome to [publish Actors](/platform/actors/publishing) in [Apify Store](https://apify.com/store), and you can even [monetize your Actors](/platform/actors/publishing/monetize). +The Apify platform provides an open [API](/api/v2), cron-style [scheduler](../../schedules), [webhooks](../../../integrations/programming/webhooks/index.md), and [integrations](../../integrations) to services such as Zapier or Make, which make it easy for users to integrate Actors with their existing workflows. Anyone is welcome to [publish Actors](/platform/actors/publishing) in [Apify Store](https://apify.com/store), and you can even [monetize your Actors](/platform/actors/publishing/monetize). -Actors can be developed and run locally and then easily deployed to the Apify platform using the [Apify CLI](/cli) or a [GitHub integration](../../../integrations/github.md). For more details, see the [Deployment](../deployment/index.md) section. +Actors can be developed and run locally and then easily deployed to the Apify platform using the [Apify CLI](/cli) or a [GitHub integration](../../../integrations/programming/github.md). For more details, see the [Deployment](../deployment/index.md) section. > **To get a better idea of what Apify Actors are, visit [Apify Store](https://apify.com/store), and try out some of them!** diff --git a/sources/platform/actors/development/deployment/source_types.md b/sources/platform/actors/development/deployment/source_types.md index 99632b06e3..ea0a91681f 100644 --- a/sources/platform/actors/development/deployment/source_types.md +++ b/sources/platform/actors/development/deployment/source_types.md @@ -34,7 +34,7 @@ To specify a Git branch or tag to check out, add a URL fragment to the URL. For Optionally, the second part of the fragment in the Git URL (separated by a colon) specifies the directory from which the Actor will be built (and where the `.actor`) folder is located. For example, `https://github.com/jancurn/some-actor.git#develop:some/dir` will check out the **develop** branch and set **some/dir** as the root directory of the Actor. -Note that you can easily set up an integration where the Actor is automatically rebuilt on every commit to the Git repository. For more details, see [GitHub integration](../../../integrations/github.md). +Note that you can easily set up an integration where the Actor is automatically rebuilt on every commit to the Git repository. For more details, see [GitHub integration](../../../integrations/programming/github.md). ### [](#private-repositories)Private repositories diff --git a/sources/platform/integrations/actors/_category_.yml b/sources/platform/integrations/actors/_category_.yml new file mode 100644 index 0000000000..51e68dbcf6 --- /dev/null +++ b/sources/platform/integrations/actors/_category_.yml @@ -0,0 +1 @@ +position: 3 diff --git a/sources/platform/integrations/actors/index.md b/sources/platform/integrations/actors/index.md index c45e134dc6..b024e5bce3 100644 --- a/sources/platform/integrations/actors/index.md +++ b/sources/platform/integrations/actors/index.md @@ -1,7 +1,7 @@ --- -title: Actors +title: Actor-to-Actor description: Learn how to integrate with other Actors and tasks. -sidebar_position: 11.10 +sidebar_label: Actor-to-Actor slug: /integrations/actors --- diff --git a/sources/platform/integrations/actors/integration_ready_actors.md b/sources/platform/integrations/actors/integration_ready_actors.md index c81d64cc9c..e7b40bb697 100644 --- a/sources/platform/integrations/actors/integration_ready_actors.md +++ b/sources/platform/integrations/actors/integration_ready_actors.md @@ -1,5 +1,5 @@ --- -title: Integration-ready Actors +title: Creating integration Actors description: Learn how to create Actors that are ready to be integrated with other Actors and tasks. sidebar_position: 1 slug: /integrations/actors/integration-ready-actors diff --git a/sources/platform/integrations/ai/_category_.yml b/sources/platform/integrations/ai/_category_.yml new file mode 100644 index 0000000000..2bc8d69435 --- /dev/null +++ b/sources/platform/integrations/ai/_category_.yml @@ -0,0 +1,2 @@ +label: 'AI' +position: 6 diff --git a/sources/platform/integrations/flowise.md b/sources/platform/integrations/ai/flowise.md similarity index 87% rename from sources/platform/integrations/flowise.md rename to sources/platform/integrations/ai/flowise.md index f7f46e7691..227ad4ec50 100644 --- a/sources/platform/integrations/flowise.md +++ b/sources/platform/integrations/ai/flowise.md @@ -1,7 +1,8 @@ --- -title: Flowise +title: Flowise integration description: Learn how to integrate Apify with Flowise. -sidebar_position: 11.20 +sidebar_label: Flowise +sidebar_position: 3 slug: /integrations/flowise --- @@ -43,15 +44,15 @@ The first step is to create a new flow in the web UI. In the left menu, you need to find Apify Website Content Crawler under Document Loaders. -![Flowise add Apify Crawler](./images/flowise-apify.png) +![Flowise add Apify Crawler](../images/flowise-apify.png) Now you need to configure the crawler. You can find more information about the crawler [here](https://apify.com/apify/website-content-crawler). -![Flowise and Apify](images/flowise.png) +![Flowise and Apify](../images/flowise.png) In the configuration, provide your Apify API token, which you can find in your [Apify account](https://my.apify.com/account#/integrations). -![Apify API token screen](./images/flowise-apify-api.png) +![Apify API token screen].(./images/flowise-apify-api.png) You can add more loaders, or you can add some processors to process the data. In our case, we create the flow that loads data from the Apify docs using Website Content Crawler and save them into the in-memory vector database. @@ -59,7 +60,7 @@ Connect the ChatOpenAI and the OpenAI embeddings and QA retrieval into the chatb The final flow can answer questions about Apify docs. -![Flowise and Apify](images/flowise-2.png) +![Flowise and Apify](../images/flowise-2.png) For more information visit the Flowise [documentation](https://flowiseai.com/). diff --git a/sources/platform/integrations/langchain.md b/sources/platform/integrations/ai/langchain.md similarity index 98% rename from sources/platform/integrations/langchain.md rename to sources/platform/integrations/ai/langchain.md index 3afb5f82c0..b5a99f3350 100644 --- a/sources/platform/integrations/langchain.md +++ b/sources/platform/integrations/ai/langchain.md @@ -1,8 +1,8 @@ --- -title: 🦜🔗 LangChain +title: 🦜🔗 LangChain integration sidebar_label: LangChain description: Learn how to integrate Apify with 🦜🔗 LangChain, in order to feed vector databases and LLMs with data crawled from the web. -sidebar_position: 11.19 +sidebar_position: 1 slug: /integrations/langchain --- diff --git a/sources/platform/integrations/llama.md b/sources/platform/integrations/ai/llama.md similarity index 97% rename from sources/platform/integrations/llama.md rename to sources/platform/integrations/ai/llama.md index c7fd6e4405..bd00a7e6c4 100644 --- a/sources/platform/integrations/llama.md +++ b/sources/platform/integrations/ai/llama.md @@ -1,7 +1,8 @@ --- -title: LlamaIndex +title: LlamaIndex integration description: Learn how to integrate Apify with LlamaIndex in order to feed vector databases and LLMs with data crawled from the web. -sidebar_position: 11.21 +sidebar_label: Llamaindex +sidebar_position: 2 slug: /integrations/llama --- diff --git a/sources/platform/integrations/pinecone.md b/sources/platform/integrations/ai/pinecone.md similarity index 94% rename from sources/platform/integrations/pinecone.md rename to sources/platform/integrations/ai/pinecone.md index 9dc7fe0cb0..e292b94078 100644 --- a/sources/platform/integrations/pinecone.md +++ b/sources/platform/integrations/ai/pinecone.md @@ -1,7 +1,8 @@ --- -title: Pinecone +title: Pinecone integration description: Learn how to integrate Apify with Pinecone to feed data crawled from the web into the Pinecone vector database. -sidebar_position: 11.22 +sidebar_label: Pinecone +sidebar_position: 4 slug: /integrations/pinecone toc_min_heading_level: 2 toc_max_heading_level: 4 @@ -41,11 +42,11 @@ The examples utilize the Website Content Crawler Actor, which deeply crawls webs 1. Once you have the crawler ready, navigate to the integration section and add Apify’s Pinecone integration. - ![Website Content Crawler with Pinecone integration](./images/pinecone-wcc-integration.png) + ![Website Content Crawler with Pinecone integration](../images/pinecone-wcc-integration.png) 1. Select when to trigger this integration (typically when a run succeeds) and fill in all the required fields for the Pinecone integration. You can learn more about the input parameters at the [Pinecone integration input schema](https://apify.com/jan.turon/pinecone-integration/input-schema). - ![Pinecone integration configuration](./images/pinecone-integration-setup.png) + ![Pinecone integration configuration](../images/pinecone-integration-setup.png) 1. For a comprehensive explanation on how to combine Actors to accomplish more complex tasks, refer to the guide on [Actor-to-Actor](https://blog.apify.com/connecting-scrapers-apify-integration/) integrations. diff --git a/sources/platform/integrations/data-storage/_category_.yml b/sources/platform/integrations/data-storage/_category_.yml new file mode 100644 index 0000000000..9353a3f9eb --- /dev/null +++ b/sources/platform/integrations/data-storage/_category_.yml @@ -0,0 +1,2 @@ +label: Data Storage +position: 5 diff --git a/sources/platform/integrations/airbyte.md b/sources/platform/integrations/data-storage/airbyte.md similarity index 84% rename from sources/platform/integrations/airbyte.md rename to sources/platform/integrations/data-storage/airbyte.md index f1a19ba12c..8ba62f75e0 100644 --- a/sources/platform/integrations/airbyte.md +++ b/sources/platform/integrations/data-storage/airbyte.md @@ -1,8 +1,8 @@ --- -title: Airbyte -sidebar_lbel: Airbyte +title: Airbyte integration description: Learn how to integrate your Apify datasets with Airbyte. -sidebar_position: 11.15 +sidebar_label: Airbyte +sidebar_position: 1 slug: /integrations/airbyte --- @@ -23,19 +23,19 @@ To use Airbyte's Apify connector you need to: Once you have all the necessary accounts set up, you need to set up the Apify connector. To do so, you will need to navigate to **Sources** tab in Airbyte and select **Apify Dataset** -![Airbyte sources tab](./images/airbyte-sources.png) +![Airbyte sources tab](../images/airbyte-sources.png) You will need to provide a **dataset ID** and your Apify API Token. You can find both of these in [Apify Console](https://console.apify.com). -![Airbyte source setup](./images/airbyte-source-setup.png) +![Airbyte source setup](../images/airbyte-source-setup.png) To find your **dataset ID**, you need to navigate to the **Storage** tab in Apify Console. Copy it and paste it in Airbyte. -![Datasets in app](./images/datasets-app.png) +![Datasets in app](../images/datasets-app.png) To find your Apify API token, you need to navigate to the **Settings** tab and select **Integrations**. Copy it and paste it in the relevant field in Airbyte. -![Integrations token](./images/apify-integrations-token.png) +![Integrations token](../images/apify-integrations-token.png) And that's it! You now have Apify datasets set up as a Source, and you can use Airbyte to transfer your datasets to one of the available destinations. diff --git a/sources/platform/integrations/drive.md b/sources/platform/integrations/data-storage/drive.md similarity index 75% rename from sources/platform/integrations/drive.md rename to sources/platform/integrations/data-storage/drive.md index bfd3dacf6f..3622634ee3 100644 --- a/sources/platform/integrations/drive.md +++ b/sources/platform/integrations/data-storage/drive.md @@ -1,8 +1,8 @@ --- -title: Google Drive -sidebar_label: Google Drive +title: Google Drive integration description: Learn how to integrate Apify with Google Drive -sidebar_position: 11.18 +sidebar_label: Google Drive +sidebar_position: 3 slug: /integrations/drive --- @@ -26,19 +26,19 @@ To use the Apify integration for Google Drive, you will need: 1. Head over to **Integrations** tab in your saved task and click on the Google Drive integration. - ![Google Drive integration](./images/gdrive/google-maps-task-integrations.png) + ![Google Drive integration](../images/gdrive/google-maps-task-integrations.png) 1. Click on **Sign in with Google** button and select the account with which you want to use the integration. - ![Google Drive integration signup](./images/gdrive/google-maps-task-integration-setup.png) + ![Google Drive integration signup](../images/gdrive/google-maps-task-integration-setup.png) 1. Select the desired format of the dataset file. - ![Google Drive integration format](./images/gdrive/google-maps-task-integration-format.png) + ![Google Drive integration format](../images/gdrive/google-maps-task-integration-format.png) 1. Click on **Save** & enable the integration. - ![Google Drive integration save](./images/gdrive/google-maps-task-integration-save.png) + ![Google Drive integration save](../images/gdrive/google-maps-task-integration-save.png) Once this is done, run your Actor to test whether the integration is working. diff --git a/sources/platform/integrations/keboola.md b/sources/platform/integrations/data-storage/keboola.md similarity index 86% rename from sources/platform/integrations/keboola.md rename to sources/platform/integrations/data-storage/keboola.md index 85ebf44b7e..9cb0790791 100644 --- a/sources/platform/integrations/keboola.md +++ b/sources/platform/integrations/data-storage/keboola.md @@ -1,8 +1,8 @@ --- -title: Keboola -sidebar_lbel: Keboola +title: Keboola integration description: Learn how to integrate your Apify datasets with Airbyte. -sidebar_position: 11.16 +sidebar_label: Keboola +sidebar_position: 2 slug: /integrations/keboola --- @@ -25,25 +25,25 @@ To use the Apify integration on Keboola, you will need to: Once your Keboola account is ready and you are logged in, navigate to the **Components** section in the top menu and click the **Add Component** button. -![Keboola dashboard](./images/keboola/keboola-dashboard.png) +![Keboola dashboard](../images/keboola/keboola-dashboard.png) In the list of available Components, find and select the **Apify** from Data Sources and click on the **Add Component** button. -![Keboola component search](./images/keboola/keboola-components.png) +![Keboola component search](../images/keboola/keboola-components.png) On the new window, click **Connect** to my data** -![Keboola Connector](./images/keboola/keboola-connector.png) +![Keboola Connector](../images/keboola/keboola-connector.png) Provide a name and description for your configuration, then click the **Create** Configuration** button. -![Keboola configuration setup](./images/keboola/keboola-create-configuration.png) +![Keboola configuration setup](../images/keboola/keboola-create-configuration.png) ### Step 2: Configure the Apify Data Source With the new configuration created, you can now configure the data source to retrieve the needed data. Click on the **Configure Component** button to begin the setup process. -![Keboola component configuration](./images/keboola/keboola-configure-component.png) +![Keboola component configuration](../images/keboola/keboola-configure-component.png) #### Choose an action @@ -56,13 +56,13 @@ In the next step, you can choose the action you want to perform: - **Retrieve items from the last task run** - This action takes the dataset of a specific task last run. - **Retrieve items from Dataset**: This action takes the dataset ID or dataset name and retrieves all items from that dataset. -![Keboola component action setup ](./images/keboola/keboola-component-setup.png) +![Keboola component action setup ](../images/keboola/keboola-component-setup.png) #### Authentication After selecting the action, you will need to provide your Apify API credentials. You can find these credentials on your Apify account page by navigating to **Settings > Integrations** and copying them into the provided form. -![Keboola API authentication](./images/keboola/keboola-setup-api-token.png) +![Keboola API authentication](../images/keboola/keboola-setup-api-token.png) #### Specifications @@ -77,13 +77,13 @@ In the specifications step, you can set up various options for your Actor run: Once you have filled in all the necessary options, click the **Save** button to save your configuration. -![Keboola component specification setup](./images/keboola/keboola-setup-specification.png) +![Keboola component specification setup](../images/keboola/keboola-setup-specification.png) ### Step 3: Run the configured Data Source After your data source has been configured, you can run it by clicking the **Run** button in the upper-right corner of your configuration. -![Keboola run configured component](./images/keboola/keboola-run-component.png) +![Keboola run configured component](../images/keboola/keboola-run-component.png) You can monitor the progress of your run in the job detail section on the right-hand side of the page. diff --git a/sources/platform/integrations/index.mdx b/sources/platform/integrations/index.mdx index 8393915df0..87cf31c858 100644 --- a/sources/platform/integrations/index.mdx +++ b/sources/platform/integrations/index.mdx @@ -116,12 +116,6 @@ If you use one of the main automation platforms, Apify support is here for you. imageUrl="/img/platform/integrations/zapier.svg" smallImage /> - - ## Data pipelines, ETLs, and AI/LLM tools The Apify platform integrates with popular ETL and data pipeline services, enabling you to integrate Apify Actors directly into your data integration processes. @@ -148,12 +141,6 @@ The Apify platform integrates with popular ETL and data pipeline services, enabl imageUrl="/img/platform/integrations/airbyte.svg" smallImage /> -
@@ -181,10 +168,9 @@ If you are working on an AI/LLM-related project, we recommend you look into the - ## Other Actors diff --git a/sources/platform/integrations/integrate_with_apify.md b/sources/platform/integrations/integrate_with_apify.md index 0bd34ee6b4..c2daca3cf6 100644 --- a/sources/platform/integrations/integrate_with_apify.md +++ b/sources/platform/integrations/integrate_with_apify.md @@ -1,6 +1,6 @@ --- title: Integrate with Apify 🤝 -sidebar_label: Integrate with Apify +sidebar_label: Create new integration description: Learn about how to integrate your service with Apify to benefit from a mutual integration. sidebar_position: 90.00 slug: /integrations/integrate @@ -8,9 +8,9 @@ slug: /integrations/integrate If you are building a service and your users could benefit from integrating with Apify or vice versa, we would love to hear from you! Contact us at [partners@apify.com](mailto:partners@apify.com) to discuss potential collaboration. We are always looking for ways to make our platform more useful and powerful for our users. Here are some examples of services and tools integrating with Apify: -- [Langchain](./langchain.md) integration enables developers to build their projects, such as AI chatbots, with Langchain to feed them with data from the web easily. -- [Zapier](./zapier.md) integration allows Zapier users to enrich their automation workflows with data from the web or to add additional Actions performed by [Apify Actors](https://apify.com/store). -- [Keboola](./keboola.md) integration enables Keboola users to easily pull data crawled from the web into their data pipelines. +- [Langchain](./ai/langchain.md) integration enables developers to build their projects, such as AI chatbots, with Langchain to feed them with data from the web easily. +- [Zapier](./workflows-and-notifications/zapier.md) integration allows Zapier users to enrich their automation workflows with data from the web or to add additional Actions performed by [Apify Actors](https://apify.com/store). +- [Keboola](/platform/integrations/keboola) integration enables Keboola users to easily pull data crawled from the web into their data pipelines. and many more that you can see at [integrations](./index.mdx). @@ -19,7 +19,7 @@ and many more that you can see at [integrations](./index.mdx). To integrate your service with Apify, you have two options. You can either: - build an [Apify actor](https://apify.com/docs/actor) that will be used as integration within the [Apify Console](https://console.apify.com) -- build an external integration, such as [Zapier](./zapier.md). +- build an external integration, such as [Zapier](./workflows-and-notifications/zapier.md). ![Integration-ready Actors](./images/integration-ready-actors.png) diff --git a/sources/platform/integrations/programming/_category_.yml b/sources/platform/integrations/programming/_category_.yml new file mode 100644 index 0000000000..6c538173b6 --- /dev/null +++ b/sources/platform/integrations/programming/_category_.yml @@ -0,0 +1,2 @@ +label: 'Programming' +position: 2 diff --git a/sources/platform/integrations/api.md b/sources/platform/integrations/programming/api.md similarity index 94% rename from sources/platform/integrations/api.md rename to sources/platform/integrations/programming/api.md index 6f89fbf707..af6af7cc71 100644 --- a/sources/platform/integrations/api.md +++ b/sources/platform/integrations/programming/api.md @@ -1,7 +1,8 @@ --- -title: API +title: API integration description: Learn how to integrate with Apify via API. -sidebar_position: 11.01 +sidebar_label: API +sidebar_position: 1 slug: /integrations/api --- @@ -21,7 +22,7 @@ You are not required to those packages—the REST API works with any HTTP client To access the Apify API in your integrations, you need to authenticate using your secret API token. You can find it on the [Integrations](https://console.apify.com/account?tab=integrations) page in Apify Console. Give your token a reasonable description, and never use one token for several services, much like you shouldn't use the same password for different accounts. -![Integrations page in Apify Console](./images/api-token.png) +![Integrations page in Apify Console](../images/api-token.png) ## Authentication @@ -39,7 +40,7 @@ do not require an authentication token because they contain a hard-to-guess iden When working under an organization account, you will see two types of API tokens on the Integrations page. -![Integrations page in the Apify Console in organizatoin mode](./images/api-token-organization.png) +![Integrations page in the Apify Console in organizatoin mode](../images/api-token-organization.png) The Personal API tokens are different from your own Personal API tokens mentioned above. If you use this token in an integration, it will have the same permissions that you have within the organization, and all the operations you use it for will be ascribed to you. diff --git a/sources/platform/integrations/github.md b/sources/platform/integrations/programming/github.md similarity index 82% rename from sources/platform/integrations/github.md rename to sources/platform/integrations/programming/github.md index 70293e8a1e..63eab5db43 100644 --- a/sources/platform/integrations/github.md +++ b/sources/platform/integrations/programming/github.md @@ -1,8 +1,8 @@ --- -title: GitHub -sidebar_label: GitHub +title: GitHub integration description: Learn how to integrate your Apify Actors with GitHub. This article shows you how to automatically create an issue in your repo when an Actor run fails. -sidebar_position: 11.11 +sidebar_label: GitHub +sidebar_position: 3 slug: /integrations/github --- @@ -21,24 +21,24 @@ To use the Apify integration for GitHub, you will need: Learn how to create an Actor from a GitHub repository. This is useful if you want to automatically deploy and build your code or push to your GitHub repository. -![New Actor page](./images/apify-git-repository.png) +![New Actor page](../images/apify-git-repository.png) Selecting _Link Git repository_ will open a new modal to select a provider to use. Selecting _GitHub_ will open a new window with GitHub authentication and select a GitHub repository. -![Git provider select modal](./images/apify-git-provider-select.png) +![Git provider select modal](../images/apify-git-provider-select.png) To link an account, click on _Add GitHub account_ and follow the instructions on github.com. Certain organizations or users can be selected. -![Git repository account select](./images/apify-git-repository-add.png) +![Git repository account select](../images/apify-git-repository-add.png) You can switch among all authorized users and organizations. -![Git repository account select](./images/apify-git-repository-account.png) +![Git repository account select](../images/apify-git-repository-account.png) If the required repository is missing, try finding it with _Search_. -![apify-git-repository-search.png](./images/apify-git-repository-search.png) +![apify-git-repository-search.png](../images/apify-git-repository-search.png) An Actor is created immediately from the selected repository. diff --git a/sources/platform/integrations/webhooks/actions.md b/sources/platform/integrations/programming/webhooks/actions.md similarity index 98% rename from sources/platform/integrations/webhooks/actions.md rename to sources/platform/integrations/programming/webhooks/actions.md index 52779f9c62..8bbe0fa093 100644 --- a/sources/platform/integrations/webhooks/actions.md +++ b/sources/platform/integrations/programming/webhooks/actions.md @@ -132,8 +132,8 @@ Description is an optional string that you can add to the webhook. It serves for |-------------|--------|-------------------------------------------------------------------------------------| | `userId` | string | ID of the user who owns the webhook. | | `createdAt` | string | ISO string date of the webhook's trigger event. | -| `eventType` | string | Type of the trigger event, [see Events](./events.md). | -| `eventData` | Object | Data associated with the trigger event, [see Events](./events.md). | +| `eventType` | string | Type of the trigger event, [see Events](/platform/integrations/webhooks/events). | +| `eventData` | Object | Data associated with the trigger event, [see Events](/platform/integrations/webhooks/events). | | `resource` | Object | The resource that caused the trigger event, [see below](#resource). | #### Resource diff --git a/sources/platform/integrations/webhooks/ad_hoc_webhooks.md b/sources/platform/integrations/programming/webhooks/ad_hoc_webhooks.md similarity index 100% rename from sources/platform/integrations/webhooks/ad_hoc_webhooks.md rename to sources/platform/integrations/programming/webhooks/ad_hoc_webhooks.md diff --git a/sources/platform/integrations/webhooks/events.md b/sources/platform/integrations/programming/webhooks/events.md similarity index 91% rename from sources/platform/integrations/webhooks/events.md rename to sources/platform/integrations/programming/webhooks/events.md index 67e08c3939..ddf029df66 100644 --- a/sources/platform/integrations/webhooks/events.md +++ b/sources/platform/integrations/programming/webhooks/events.md @@ -17,7 +17,7 @@ An event is represented by a **type** and related **data**. The type is a `strin ## [](#actor-run)Actor run -Actor run events are triggered when an Actor run gets created or transitions into a new state. Webhook can be defined for all runs of an [Actor](../../actors/index.mdx) at its detail page or for a specific [Actor task](../../actors/running/tasks.md) at its detail page. In that case, the webhook is invoked only for runs started for that task. +Actor run events are triggered when an Actor run gets created or transitions into a new state. Webhook can be defined for all runs of an [Actor](../../../actors/index.mdx) at its detail page or for a specific [Actor task](../../../actors/running/tasks.md) at its detail page. In that case, the webhook is invoked only for runs started for that task. ### Run event types @@ -50,7 +50,7 @@ Note that apart from event data, actions also have the `resource` object availab ## [](#actor-build)Actor build -Actor build events are triggered when an Actor build is created or transitions into a new state. Webhooks can be defined for all of an [Actor](../../actors/index.mdx)'s builds on its detail page. +Actor build events are triggered when an Actor build is created or transitions into a new state. Webhooks can be defined for all of an [Actor](../../../actors/index.mdx)'s builds on its detail page. ### Build event types diff --git a/sources/platform/integrations/webhooks/index.md b/sources/platform/integrations/programming/webhooks/index.md similarity index 74% rename from sources/platform/integrations/webhooks/index.md rename to sources/platform/integrations/programming/webhooks/index.md index b6f18e3191..36459d2771 100644 --- a/sources/platform/integrations/webhooks/index.md +++ b/sources/platform/integrations/programming/webhooks/index.md @@ -1,12 +1,11 @@ --- -title: Webhooks +title: Webhooks integration description: Learn how to integrate multiple Apify Actors or external systems with your Actor or task run. Send alerts when your Actor run succeeds or fails. -sidebar_position: 11.02 +sidebar_position: 2 +sidebar_label: Webhooks slug: /integrations/webhooks --- -# Webhooks - **Learn how to integrate multiple Apify Actors or external systems with your Actor or task run. Send alerts when your Actor run succeeds or fails.** --- @@ -15,12 +14,12 @@ Webhooks allow you to configure the Apify platform to perform an action when a c You can find webhooks under the **Integrations** tab on an Actor's page in [Apify Console](https://console.apify.com/actors). -![Integrations tab in Apify Console](../images/integrations-tab.png) +![Integrations tab in Apify Console](../../images/integrations-tab.png) To define a webhook, select a system **event** that triggers the webhook. Then, provide the **action** to execute after the event. When the event occurs, the system executes the action. > Currently, the only available action is to send a POST HTTP request to a URL specified in the webhook. -* [**Events**](./events.md) -* [**Actions**](./actions.md) -* [**Ad-hoc webhooks**](./ad_hoc_webhooks.md) +* [**Events**](/platform/integrations/webhooks/events) +* [**Actions**](/platform/integrations/webhooks/actions) +* [**Ad-hoc webhooks**](/platform/integrations/webhooks/ad-hoc-webhooks) diff --git a/sources/platform/integrations/workflows-and-notifications/_category_.yml b/sources/platform/integrations/workflows-and-notifications/_category_.yml new file mode 100644 index 0000000000..836d96ded0 --- /dev/null +++ b/sources/platform/integrations/workflows-and-notifications/_category_.yml @@ -0,0 +1,2 @@ +label: Workflows & notifications +position: 4 diff --git a/sources/platform/integrations/gmail.md b/sources/platform/integrations/workflows-and-notifications/gmail.md similarity index 74% rename from sources/platform/integrations/gmail.md rename to sources/platform/integrations/workflows-and-notifications/gmail.md index 8fbc3b1b20..56c1c18378 100644 --- a/sources/platform/integrations/gmail.md +++ b/sources/platform/integrations/workflows-and-notifications/gmail.md @@ -1,8 +1,8 @@ --- -title: Gmail -sidebar_label: Gmail +title: Gmail integration description: Learn how to integrate Apify with Gmail -sidebar_position: 11.17 +sidebar_label: Gmail +sidebar_position: 5 slug: /integrations/gmail --- @@ -26,29 +26,29 @@ To use the Apify integration for Gmail, you will need: 1. Head over to **Integrations** tab in your task and click on Gmail integration. - ![Gmail integration](./images/gmail/google-maps-task-integrations.png) + ![Gmail integration](../images/gmail/google-maps-task-integrations.png) 1. In the popup window select: - Send results email via Gmail - Get notified when the run fails - ![Gmail integration setup](./images/gmail/google-maps-task-configuration.png) + ![Gmail integration setup](../images/gmail/google-maps-task-configuration.png) 1. Click on **Sign in with Google** button and select the account with which you want to use the integration. - ![Gmail integration email signup](./images/gmail/google-maps-task-email.png) + ![Gmail integration email signup](../images/gmail/google-maps-task-email.png) 1. After signing in you need to specify to what email account you want to send the message through the integration. Optionally you can also specify the subject and body of the email that will be sent. - ![Gmail integration email setup](./images/gmail/google-maps-task-email-filled.png) + ![Gmail integration email setup](../images/gmail/google-maps-task-email-filled.png) 1. Select the desired format of the attached dataset file. - ![Gmail integration format selection](./images/gmail/google-maps-task-email-format.png) + ![Gmail integration format selection](../images/gmail/google-maps-task-email-format.png) 1. Click on save & enable the integration. - ![Gmail integration save](./images/gmail/google-maps-task-email-save.png) + ![Gmail integration save](../images/gmail/google-maps-task-email-save.png) Once this is done, run your Actor to test whether the integration is working. diff --git a/sources/platform/integrations/make.md b/sources/platform/integrations/workflows-and-notifications/make.md similarity index 94% rename from sources/platform/integrations/make.md rename to sources/platform/integrations/workflows-and-notifications/make.md index 57d74c89ef..5b99a4ef29 100644 --- a/sources/platform/integrations/make.md +++ b/sources/platform/integrations/workflows-and-notifications/make.md @@ -1,8 +1,8 @@ --- -title: Make -sidebar_label: Make +title: Make integration description: Learn how to integrate your Apify Actors with Make. -sidebar_position: 11.15 +sidebar_label: Make +sidebar_position: 2 slug: /integrations/make --- @@ -25,17 +25,17 @@ Add the Apify module to your scenario. You can find this module by searching for Next, select one of the available options under Triggers, Actions and Searches, then click on the Apify module to open its configuration window. -![Apify module](./images/apify-module.png) +![Apify module](../images/apify-module.png) ## Step 2: Create a connection to your Apify account In the Connection configuration window, you will need to provide your Apify API token. -![API token](./images/apify-token.png) +![API token](../images/apify-token.png) You can find the token in the Apify Console by navigating to **Settings > Integrations**. -![Integrations token](./images/apify-integrations-token.png) +![Integrations token](../images/apify-integrations-token.png) Finally, copy your API token to the Make module and save it to create a connection. @@ -47,7 +47,7 @@ Congratulations! You have successfully connected the Apify app and can now use i > Triggers when a selected Actor run is finished. - + | Input | Description | | :----------- | :--------------------------------------------------------------------- | @@ -71,7 +71,7 @@ Congratulations! You have successfully connected the Apify app and can now use i > Runs a selected Actor task. - + | Input | Description | | :------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -83,7 +83,7 @@ Congratulations! You have successfully connected the Apify app and can now use i > Runs a selected Actor. - + | Input | Description | @@ -101,7 +101,7 @@ Congratulations! You have successfully connected the Apify app and can now use i > Retrieves items from a [dataset](/platform/storage/dataset). - + | Input | Description | diff --git a/sources/platform/integrations/slack.md b/sources/platform/integrations/workflows-and-notifications/slack.md similarity index 92% rename from sources/platform/integrations/slack.md rename to sources/platform/integrations/workflows-and-notifications/slack.md index 4c457db4d6..10c1d2ca45 100644 --- a/sources/platform/integrations/slack.md +++ b/sources/platform/integrations/workflows-and-notifications/slack.md @@ -1,8 +1,8 @@ --- -title: Slack -sidebar_label: Slack +title: Slack integration description: Learn how to integrate your Apify Actors with Slack. This article guides you from installation through to automating your whole workflow in Slack. -sidebar_position: 11.16 +sidebar_label: Slack +sidebar_position: 4 slug: /integrations/slack --- @@ -30,11 +30,11 @@ You can find all integrations on an Actor's or task's **Integrations** tab. For Find the integration for Slack, then click the **Configure** button. You will be prompted to log in with your Slack account and select your workspace in the **Settings > Integrations** window. -![Integrations tab](./images/integrations-tab.png) +![Integrations tab](../images/integrations-tab.png) Then, head back to your task to finish the setup. Select what type of events you would like to be notified of (e.g., when a run is created, when a run succeeds, when a run fails, etc.), your workspace, and the channel you want to receive the notifications in (you can set up an ad-hoc channel for this test). In the **Message** field, you can see how the notification will look, or you can craft a new custom one. -![Integration setup](./images/slack-integration-setup.png) +![Integration setup](../images/slack-integration-setup.png) Once you are done, click the **Save** button. @@ -46,7 +46,7 @@ Click the **Start** button and head to the Slack channel you selected to see you You can now run the same Actor or task directly from Slack by typing `/apify call [Actor or task ID]` into the Slack message box. -![Use Apify from Slack](./images/slack-apify-message.png) +![Use Apify from Slack](../images/slack-apify-message.png) When an Actor doesn't require you to fill in any input fields, you can run it by simply typing `/apify call [Actor or task ID]`. diff --git a/sources/platform/integrations/telegram.md b/sources/platform/integrations/workflows-and-notifications/telegram.md similarity index 84% rename from sources/platform/integrations/telegram.md rename to sources/platform/integrations/workflows-and-notifications/telegram.md index 022ae70355..f835596a5e 100644 --- a/sources/platform/integrations/telegram.md +++ b/sources/platform/integrations/workflows-and-notifications/telegram.md @@ -2,7 +2,7 @@ title: Telegram integration through Zapier sidebar_label: Telegram description: Learn how to integrate your Apify Actors with Zapier. -sidebar_position: 11.13 +sidebar_position: 3 slug: /integrations/telegram --- @@ -37,7 +37,7 @@ In the create Zap form, you can choose whether you want to use Apify as the trig Click on Trigger and find Apify using the search box. -![Zapier choosing source of trigger](./images/zapier-trigger.png) +![Zapier choosing source of trigger](../images/zapier-trigger.png) You have two possible triggers that you can choose while setting up your Telegram integration @@ -45,7 +45,7 @@ You have two possible triggers that you can choose while setting up your Telegra - Finished Task Run - triggers upon the completion of a selected Actor task run. -![Zapier choosing trigger event](./images/zapier-zap-choose-event.png) +![Zapier choosing trigger event](../images/zapier-zap-choose-event.png) :::info Available Actors & Tasks @@ -61,11 +61,11 @@ Click on the "Sign in" button next to the Connect to Apify title. Or you can sel The connection configuration options open in a new tab in your browser or in a modal window. -![Apify Zapier connection](./images/zapier-new-connection.png) +![Apify Zapier connection](../images/zapier-new-connection.png) In connection configuration, you need to provide your Apify API Token. You can find the token in Apify Console by navigating to **Settings > Integrations**. -![Integrations token](./images/apify-integrations-token.png) +![Integrations token](../images/apify-integrations-token.png) Copy the token and paste it into the configuration form and continue with the "Yes, Continue to Apify" button. @@ -77,7 +77,7 @@ The connection is now created and the configuration form closed. After setting up Apify as your trigger within Zapier, it's time to set up Telegram as the action that will occur based on the trigger. -![Choosing action source within Zapier](./images/zapier-zap-choose-action.png) +![Choosing action source within Zapier](../images/zapier-zap-choose-action.png) You have two possible actions that you can choose while setting up your Telegram integration @@ -85,21 +85,21 @@ You have two possible actions that you can choose while setting up your Telegram - Send Poll - sends a poll from your bot when trigger activates. -![Zapier choosing action event](./images/zapier-zap-choose-event-2.png) +![Zapier choosing action event](../images/zapier-zap-choose-event-2.png) After you choose your event that will be happening after trigger, you need to connect your Telegram bot that will be responsible for sending the message or sending polls. -![Telegram bot HTTP token](./images/zapier-zap-telegram-access.png) +![Telegram bot HTTP token](../images/zapier-zap-telegram-access.png) The best way to do it's to: 1. Start conversation with Telegrams BotFather, a bot that manages bots on Telegram. - ![BotFather conversation](./images/botfather-start.png) + ![BotFather conversation](../images/botfather-start.png) 1. Issue the `/newbot` command in conversation with it and follow the instructions, until you get your HTTP API token. - ![BotFather conversation with new HTTP API token](./images/botfather-HTTP-API-blurred.png) + ![BotFather conversation with new HTTP API token](../images/botfather-HTTP-API-blurred.png) ### Step 2: Create action for your new Telegram bot @@ -110,6 +110,6 @@ Start new conversation with your bot and copy the **Chat-Id** and input it withi Select **Chat-Id**, **Text Format**, and a **Message Text** that suits your need for example -![Zapier choosing Action event](./images/zapier-zap-action.png) +![Zapier choosing Action event](../images/zapier-zap-action.png) Once you fill all required fields, you can test your integration and if everything works hit **Publish** and you are done! diff --git a/sources/platform/integrations/zapier.md b/sources/platform/integrations/workflows-and-notifications/zapier.md similarity index 92% rename from sources/platform/integrations/zapier.md rename to sources/platform/integrations/workflows-and-notifications/zapier.md index 14fc3b91c7..3539c606cf 100644 --- a/sources/platform/integrations/zapier.md +++ b/sources/platform/integrations/workflows-and-notifications/zapier.md @@ -1,8 +1,8 @@ --- -title: Zapier -sidebar_label: Zapier +title: Zapier integration description: Learn how to integrate your Apify Actors with Zapier. -sidebar_position: 11.12 +sidebar_label: Zapier +sidebar_position: 1 slug: /integrations/zapier --- @@ -33,11 +33,11 @@ In the create Zap form, you can choose whether you want to use Apify as the trig Click on Trigger and find Apify using the search box. -![Apify Zapier Trigger 2](./images/zapier-trigger.png) +![Apify Zapier Trigger 2](../images/zapier-trigger.png) Then select which trigger you want to use. -![Apify Zapier Trigger 2](./images/zapier-trigger-2.png) +![Apify Zapier Trigger 2](../images/zapier-trigger-2.png) ### Step 2: Create a connection to your Apify account @@ -47,11 +47,11 @@ Click on the "Sign in" button next to the Connect to Apify title. Or you can sel The connection configuration options open in a new tab in your browser or in a modal window. -![Apify Zapier connection](./images/zapier-new-connection.png) +![Apify Zapier connection](../images/zapier-new-connection.png) In connection configuration, you need to provide your Apify API Token. You can find the token in Apify Console by navigating to **Settings > Integrations**. -![Integrations token](./images/apify-integrations-token.png) +![Integrations token](../images/apify-integrations-token.png) Copy the token and paste it into the configuration form and continue with the "Yes, Continue to Apify" button. @@ -69,7 +69,7 @@ In this guide we'll show you how to use Apify as an action to start an Actor run After you select Apify as an action, you need to select the action you want to use. Let's use the "Run Actor" action for this example. -![Zapier Action](./images/zapier-action-1.png) +![Zapier Action](../images/zapier-action-1.png) You need to select the connection you want to use. If you don't have any connections, you can create a new one by clicking on the "Sign in" button and follow the steps in Step 2. @@ -77,7 +77,7 @@ In the next step, you need to select the Actor you want to use. You can use the We will use the Web Scraper Actor in this example. -![Zapier Action](./images/zapier-action-2.png) +![Zapier Action](../images/zapier-action-2.png) You need to fill the input for the Actor and use the "Continue" button to advance to the next step. @@ -88,7 +88,7 @@ In the next step, you can test the action and check if everything is using the " This button runs the Actor run on Apify and you can see the data in Zapier. -![Zapier Action](./images/zapier-action-3.png) +![Zapier Action](../images/zapier-action-3.png) Once you are happy with the test, you can publish the Zap. When it is turned on, it will run the Actor every time the trigger is fired. diff --git a/sources/platform/storage/dataset.md b/sources/platform/storage/dataset.md index fd4d761261..fda4a5eb0d 100644 --- a/sources/platform/storage/dataset.md +++ b/sources/platform/storage/dataset.md @@ -218,7 +218,7 @@ The [Apify API](/api/v2#/reference/datasets) enables you progammatic access to y If you are accessing your datasets using the `username~store-name` [store ID format](./index.md), you will need to use your [secret API token](../integrations/index.mdx#api-token). You can find the token (and your user ID) on the [Integrations](https://console.apify.com/account#/integrations)tab of **Settings** page of your Apify account. -> When providing your API authentication token, we recommend using the request's `Authorization` header, rather than the URL. ([More info](../integrations/api.md#authentication)). +> When providing your API authentication token, we recommend using the request's `Authorization` header, rather than the URL. ([More info](../integrations/programming/api.md#authentication)). To retrieve a list of you datasets, send a GET request to the [Get list of datasets](/api/v2#/reference/datasets/get-list-of-datasets) endpoint. diff --git a/sources/platform/storage/key_value_store.md b/sources/platform/storage/key_value_store.md index e8128224fd..1f24e8de8e 100644 --- a/sources/platform/storage/key_value_store.md +++ b/sources/platform/storage/key_value_store.md @@ -203,7 +203,7 @@ The [Apify API](/api/v2#/reference/key-value-stores) enables you programmatic ac If you are accessing your datasets using the `username~store-name` [store ID format](./index.md), you will need to use your [secret API token](../integrations/index.mdx#api-token). You can find the token (and your user ID) on the [Integrations](https://console.apify.com/account#/integrations) tab of **Settings** page of your Apify account. -> When providing your API authentication token, we recommend using the request's `Authorization` header, rather than the URL. ([More info](../integrations/api.md#authentication)). +> When providing your API authentication token, we recommend using the request's `Authorization` header, rather than the URL. ([More info](../integrations/programming/api.md#authentication)). To retrieve a list of your key-value stores, send a GET request to the [Get list of key-value stores](/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores) endpoint. diff --git a/sources/platform/storage/request_queue.md b/sources/platform/storage/request_queue.md index ba3592b544..2f7e7e7c8f 100644 --- a/sources/platform/storage/request_queue.md +++ b/sources/platform/storage/request_queue.md @@ -215,7 +215,7 @@ The [Apify API](/api/v2#/reference/request-queues) allows you programmatic acces If you are accessing your datasets using the `username~store-name` [store ID format](./index.md), you will need to use your [secret API token](../integrations/index.mdx#api-token). You can find the token (and your user ID) on the [Integrations](https://console.apify.com/account#/integrations) page of your Apify account. -> When providing your API authentication token, we recommend using the request's `Authorization` header, rather than the URL. ([More info](../integrations/api.md#authentication)). +> When providing your API authentication token, we recommend using the request's `Authorization` header, rather than the URL. ([More info](../integrations/programming/api.md#authentication)). To get a list of your request queues, send a GET request to the [Get list of request queues](/api/v2#/reference/request-queues/store-collection/get-list-of-request-queues) endpoint. diff --git a/static/img/platform/integrations/pinecone.png b/static/img/platform/integrations/pinecone.png deleted file mode 100644 index 052d1149a5..0000000000 Binary files a/static/img/platform/integrations/pinecone.png and /dev/null differ diff --git a/static/img/platform/integrations/pinecone.svg b/static/img/platform/integrations/pinecone.svg new file mode 100644 index 0000000000..02ae61cf45 --- /dev/null +++ b/static/img/platform/integrations/pinecone.svg @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + + + + + + + + + + +