diff --git a/.github/styles/Vocab/Docs/accept.txt b/.github/styles/config/vocabularies/Docs/accept.txt similarity index 100% rename from .github/styles/Vocab/Docs/accept.txt rename to .github/styles/config/vocabularies/Docs/accept.txt diff --git a/.github/styles/Vocab/Docs/reject.txt b/.github/styles/config/vocabularies/Docs/reject.txt similarity index 100% rename from .github/styles/Vocab/Docs/reject.txt rename to .github/styles/config/vocabularies/Docs/reject.txt diff --git a/sources/platform/integrations/api.md b/sources/platform/integrations/api.md index 360cd8c32..6f89fbf70 100644 --- a/sources/platform/integrations/api.md +++ b/sources/platform/integrations/api.md @@ -5,8 +5,6 @@ sidebar_position: 11.01 slug: /integrations/api --- -# API - **Learn how to integrate with Apify using the REST API.** --- @@ -27,7 +25,7 @@ To access the Apify API in your integrations, you need to authenticate using you ## Authentication -There are 2 ways how to authenticate the Apify API. You can either pass the token via the `Authorization` HTTP header or the URL `token` query parameter. We always recommend you use the authentication via the HTTP header as this method is more secure. +You can authenticate the Apify API in two ways. You can either pass the token via the `Authorization` HTTP header or the URL `token` query parameter. We always recommend you use the authentication via the HTTP header as this method is more secure. > **IMPORTANT**: **Do not share the API token with untrusted parties, or use it directly from client-side code, unless you fully understand the consequences!** diff --git a/sources/platform/integrations/chatgpt.md b/sources/platform/integrations/chatgpt.md index d2cd62fd4..f21a1a82f 100644 --- a/sources/platform/integrations/chatgpt.md +++ b/sources/platform/integrations/chatgpt.md @@ -1,7 +1,8 @@ --- -title: ChatGPT plugin +title: Apify ChatGPT plugin +sidebar_lbel: ChatGPT plugin description: Let ChatGPT access up-to-date information on the web. Fetch Google Search results, crawl smaller websites, query web pages found, and download individual web pages or files. -sidebar_position: 11.23 +sidebar_position: 11.21 slug: /integrations/chatgpt-plugin --- diff --git a/sources/platform/integrations/drive.md b/sources/platform/integrations/drive.md index ceeed425d..9e8c5bf9b 100644 --- a/sources/platform/integrations/drive.md +++ b/sources/platform/integrations/drive.md @@ -1,12 +1,11 @@ --- title: Google Drive +sidebar_label: Google Drive description: Learn how to integrate Apify with Google Drive -sidebar_position: 11.15 +sidebar_position: 11.17 slug: /integrations/drive --- -# Google Drive integration - **Learn how to integrate your Apify Actors with Google Drive. This article shows you how to automatically save results to your drive when an Actor run succeeds.** --- diff --git a/sources/platform/integrations/flowise.md b/sources/platform/integrations/flowise.md index a7c4e0aa6..5f18bb26d 100644 --- a/sources/platform/integrations/flowise.md +++ b/sources/platform/integrations/flowise.md @@ -1,12 +1,10 @@ --- title: Flowise description: Learn how to integrate Apify with Flowise. -sidebar_position: 11.22 +sidebar_position: 11.19 slug: /integrations/flowise --- -# Flowise - **Learn how to integrate Apify with Flowise.** --- diff --git a/sources/platform/integrations/github.md b/sources/platform/integrations/github.md index 732ab1c65..70293e8a1 100644 --- a/sources/platform/integrations/github.md +++ b/sources/platform/integrations/github.md @@ -1,12 +1,11 @@ --- title: GitHub +sidebar_label: GitHub 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 slug: /integrations/github --- -# GitHub integration - **Learn how to integrate your Apify Actors with GitHub. This article shows you several possible integrations.** --- diff --git a/sources/platform/integrations/gmail.md b/sources/platform/integrations/gmail.md index 9e0e4b4a4..d910c7695 100644 --- a/sources/platform/integrations/gmail.md +++ b/sources/platform/integrations/gmail.md @@ -1,12 +1,11 @@ --- title: Gmail +sidebar_label: Gmail description: Learn how to integrate Apify with Gmail -sidebar_position: 11.14 +sidebar_position: 11.16 slug: /integrations/gmail --- -# Gmail integration - **Learn how to integrate your Apify Actors with Gmail. This article shows you how to automatically send an email with results when an Actor run succeeds.** --- diff --git a/sources/platform/integrations/images/botfather-HTTP-API-blurred.png b/sources/platform/integrations/images/botfather-HTTP-API-blurred.png new file mode 100644 index 000000000..58498736d Binary files /dev/null and b/sources/platform/integrations/images/botfather-HTTP-API-blurred.png differ diff --git a/sources/platform/integrations/images/botfather-start.png b/sources/platform/integrations/images/botfather-start.png new file mode 100644 index 000000000..5236d7f45 Binary files /dev/null and b/sources/platform/integrations/images/botfather-start.png differ diff --git a/sources/platform/integrations/images/zapier-dashboard-zaps.png b/sources/platform/integrations/images/zapier-dashboard-zaps.png new file mode 100644 index 000000000..4754971a2 Binary files /dev/null and b/sources/platform/integrations/images/zapier-dashboard-zaps.png differ diff --git a/sources/platform/integrations/images/zapier-zap-action.png b/sources/platform/integrations/images/zapier-zap-action.png new file mode 100644 index 000000000..4f9ed9930 Binary files /dev/null and b/sources/platform/integrations/images/zapier-zap-action.png differ diff --git a/sources/platform/integrations/images/zapier-zap-choose-action.png b/sources/platform/integrations/images/zapier-zap-choose-action.png new file mode 100644 index 000000000..8aaac654c Binary files /dev/null and b/sources/platform/integrations/images/zapier-zap-choose-action.png differ diff --git a/sources/platform/integrations/images/zapier-zap-choose-event-2.png b/sources/platform/integrations/images/zapier-zap-choose-event-2.png new file mode 100644 index 000000000..554269b1f Binary files /dev/null and b/sources/platform/integrations/images/zapier-zap-choose-event-2.png differ diff --git a/sources/platform/integrations/images/zapier-zap-choose-event.png b/sources/platform/integrations/images/zapier-zap-choose-event.png new file mode 100644 index 000000000..b42704e30 Binary files /dev/null and b/sources/platform/integrations/images/zapier-zap-choose-event.png differ diff --git a/sources/platform/integrations/images/zapier-zap-telegram-access.png b/sources/platform/integrations/images/zapier-zap-telegram-access.png new file mode 100644 index 000000000..37f3135a9 Binary files /dev/null and b/sources/platform/integrations/images/zapier-zap-telegram-access.png differ diff --git a/sources/platform/integrations/images/zapier-zap-trigger-choose.png b/sources/platform/integrations/images/zapier-zap-trigger-choose.png new file mode 100644 index 000000000..f7705a1a0 Binary files /dev/null and b/sources/platform/integrations/images/zapier-zap-trigger-choose.png differ diff --git a/sources/platform/integrations/images/zapier-zap-trigger-chosen.png b/sources/platform/integrations/images/zapier-zap-trigger-chosen.png new file mode 100644 index 000000000..fb292f812 Binary files /dev/null and b/sources/platform/integrations/images/zapier-zap-trigger-chosen.png differ diff --git a/sources/platform/integrations/langchain.md b/sources/platform/integrations/langchain.md index 4ca853797..f76d1eb20 100644 --- a/sources/platform/integrations/langchain.md +++ b/sources/platform/integrations/langchain.md @@ -1,12 +1,11 @@ --- -title: LangChain +title: 🦜🔗 LangChain +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.20 +sidebar_position: 11.18 slug: /integrations/langchain --- -# 🦜🔗 LangChain - **Learn how to integrate Apify with LangChain, in order to feed vector databases and LLMs with data crawled from the web.** --- diff --git a/sources/platform/integrations/llama.md b/sources/platform/integrations/llama.md index c081a8969..9156b6358 100644 --- a/sources/platform/integrations/llama.md +++ b/sources/platform/integrations/llama.md @@ -1,12 +1,10 @@ --- title: LlamaIndex 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.22 +sidebar_position: 11.20 slug: /integrations/llama --- -# LlamaIndex - **Learn how to integrate Apify with LlamaIndex to feed vector databases and LLMs with data crawled from the web.** --- diff --git a/sources/platform/integrations/make.md b/sources/platform/integrations/make.md index 657953afc..6036dc5e9 100644 --- a/sources/platform/integrations/make.md +++ b/sources/platform/integrations/make.md @@ -1,12 +1,11 @@ --- title: Make +sidebar_label: Make description: Learn how to integrate your Apify Actors with Make. -sidebar_position: 11.12 +sidebar_position: 11.14 slug: /integrations/make --- -# Make integration - **Learn how to integrate your Apify Actors with Make.** --- diff --git a/sources/platform/integrations/slack.md b/sources/platform/integrations/slack.md index df94986c0..a4598634f 100644 --- a/sources/platform/integrations/slack.md +++ b/sources/platform/integrations/slack.md @@ -1,12 +1,11 @@ --- title: Slack +sidebar_label: Slack 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.13 +sidebar_position: 11.15 slug: /integrations/slack --- -# Integration for Slack - **Learn how to integrate your Apify Actors with Slack. This article guides you from installation through to automating your whole workflow in Slack.** A tutorial can be found [here](https://help.apify.com/en/articles/6454058-apify-integration-for-slack). diff --git a/sources/platform/integrations/telegram.md b/sources/platform/integrations/telegram.md new file mode 100644 index 000000000..b4d71f153 --- /dev/null +++ b/sources/platform/integrations/telegram.md @@ -0,0 +1,115 @@ +--- +title: Telegram integration through Zapier +sidebar_label: Telegram +description: Learn how to integrate your Apify Actors with Zapier. +sidebar_position: 11.13 +slug: /integrations/telegram +--- + +**Learn how to integrate your Apify Actors with Telegram through Zapier.** + +--- + +With [Apify integration for Zapier](https://zapier.com/apps/apify/integrations), you can connect your Apify Actors to Slack, Trello, Google Sheets, Dropbox, Salesforce, and loads more. + +Your Zapier workflows can start Apify Actors or tasks, fetch items from a dataset, set and get records from key-value stores, or find Actor or task runs. + +You can use the Zapier integration to trigger a workflow whenever an Actor or a task finishes. + +Completementary to the following guide we've created a detailed video, that will guide you through whole process of setting up your Telegram integratin through Zapier. + + + +## Connect Apify with Zapier + +To use the Apify integration on Zapier, you will need to: + +- Have an [Apify account](https://console.apify.com/). +- Have a [Zapier account](https://zapier.com/). + +### Step 1: Create Zap and find Apify on Zapier + +Once you have your Zapier account ready and you are successfully logged in, you can create your first Zap. + +Go to the Zaps section and find the **Create Zap** button. + +In the create Zap form, you can choose whether you want to use Apify as the trigger or action for the Zap. + +Click on Trigger and find Apify using the search box. + +![Zapier choosing source of trigger](./images/zapier-trigger.png) + +You have two possible triggers that you can choose while setting up your Telegram integration + +- Finished Actor Run - triggers upon the completion of a selected Actor run. + +- Finished Task Run - triggers upon the completion of a selected Actor task run. + +![Zapier choosing trigger event](./images/zapier-zap-choose-event.png) + +:::info Available Actors & Tasks + +Please note that only Actors or Actor tasks that you previously run will be available to choose from. + +::: + +### Step 2: Create a connection to your Apify account + +The next step is to connect your Apify account. + +Click on the "Sign in" button next to the Connect to Apify title. Or you can select an account if you already have one connected. + +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) + +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) + +Copy the token and paste it into the configuration form and continue with the "Yes, Continue to Apify" button. + +The connection is now created and the configuration form closed. + +## Connect Telegram bot with Zapier + +### Step 1: Create & connect new bot on Telegram + +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) + +You have two possible actions that you can choose while setting up your Telegram integration + +- Send Message - sends a message from your bot when trigger activates. + +- Send Poll - sends a poll from your bot when trigger activates. + +![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) + +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) + +2. 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) + + +### Step 2: Create action for your new Telegram bot + +Once you've setup your new bot within Zapier, it's time to setup an action. + +Start new conversation with your bot and copy the **Chat-Id** and input it within Zapier. + +Select **Chat-Id**, **Text Format**, and a **Message Text** that suits your need for example + +![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/zapier.md index 0eeec6e1d..14fc3b91c 100644 --- a/sources/platform/integrations/zapier.md +++ b/sources/platform/integrations/zapier.md @@ -1,12 +1,11 @@ --- title: Zapier +sidebar_label: Zapier description: Learn how to integrate your Apify Actors with Zapier. sidebar_position: 11.12 slug: /integrations/zapier --- -# Zapier integration - **Learn how to integrate your Apify Actors with Zapier.** --- diff --git a/vale.ini b/vale.ini index 8df698d6d..c150c4543 100644 --- a/vale.ini +++ b/vale.ini @@ -2,7 +2,7 @@ StylesPath = .github/styles MinAlertLevel = warning IgnoredScopes = code, tt, table, tr, td -Vocab = Docs +vocabularies = Docs Packages = write-good, Microsoft