feat: add ifttt docs #1567
Open
feat: add ifttt docs #1567
Conversation
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
TC-MO
requested changes
May 12, 2025
There was a problem hiding this comment.
I've rewritten the doc to fix few issues like:
- Actor capitalization
- Fix formatting
- Restructure it for better flow
- Added docusaurus admonition
Apart from that I have few questions
- I assume this is IFTTT default light mode scheme? If yes that is unfortunate but nothing can be done about it.
- I noticed discrepancies on the screenshots, sometimes it's
Actorand other times it'sActor, would be great to unify it toActor.
| @@ -0,0 +1,123 @@ | |||
| --- | |||
| title: IFTTT integration | |||
| description: Connect Apify Actors with IFTTT to automate workflows using actor run events, data queries, and task actions. | |||
There was a problem hiding this comment.
Suggested change
| description: Connect Apify Actors with IFTTT to automate workflows using actor run events, data queries, and task actions. | |
| description: Connect Apify Actors with IFTTT to automate workflows using Actor run events, data queries, and task actions. |
Comment on lines
9
to
33
| **Learn how to integrate your Apify Actors in IFTTT Applets.** | ||
|
|
||
| This guide explains how to use the Apify integration in IFTTT to build automations (Applets) triggered by actor or task runs and start new runs automatically. | ||
|
|
||
| An Applet is built from three key parts: a trigger that kicks off the workflow, optional queries that fetch the data, and one or more actions that execute when the Applet runs. | ||
|
|
||
| --- | ||
|
|
||
| With [Apify integration for IFTTT](https://ifttt.com/apify), you can connect your Apify Actors to hundreds of services like Twitter, Gmail, Google Sheets, Slack, and more. | ||
|
|
||
| Your Applets can start Apify Actors or tasks, fetch items from a dataset and get records from key-value stores. | ||
|
|
||
| ## Connect Apify with IFTTT | ||
|
|
||
| To use the Apify integration on IFTTT, you will need to: | ||
|
|
||
| - Have an [Apify account](https://console.apify.com/). | ||
| - Have an [IFTTT account](https://ifttt.com/). | ||
|
|
||
| To connect to Apify service: | ||
|
|
||
| - visit [Apify service page](https://ifttt.com/apify) | ||
| - click "Connect" button | ||
| - you will be redirected to the Apify login page | ||
| - login to your Apify console |
There was a problem hiding this comment.
Suggested change
| **Learn how to integrate your Apify Actors in IFTTT Applets.** | |
| This guide explains how to use the Apify integration in IFTTT to build automations (Applets) triggered by actor or task runs and start new runs automatically. | |
| An Applet is built from three key parts: a trigger that kicks off the workflow, optional queries that fetch the data, and one or more actions that execute when the Applet runs. | |
| --- | |
| With [Apify integration for IFTTT](https://ifttt.com/apify), you can connect your Apify Actors to hundreds of services like Twitter, Gmail, Google Sheets, Slack, and more. | |
| Your Applets can start Apify Actors or tasks, fetch items from a dataset and get records from key-value stores. | |
| ## Connect Apify with IFTTT | |
| To use the Apify integration on IFTTT, you will need to: | |
| - Have an [Apify account](https://console.apify.com/). | |
| - Have an [IFTTT account](https://ifttt.com/). | |
| To connect to Apify service: | |
| - visit [Apify service page](https://ifttt.com/apify) | |
| - click "Connect" button | |
| - you will be redirected to the Apify login page | |
| - login to your Apify console | |
| **Connect Apify Actors with IFTTT to automate workflows using Actor run events, data queries, and task actions.** | |
| --- | |
| [IFTTT](https://ifttt.com) is a service that helps you create automated workflows called Applets. With the [Apify integration for IFTTT](https://ifttt.com/apify), you can connect your Apify Actors to hundreds of services like Twitter, Gmail, Google Sheets, Slack, and more. | |
| This guide shows you how to integrate Apify Actors with IFTTT to build automated workflows. You'll learn how to create IFTTT Applets that can be triggered by Apify events or that can execute Apify tasks. | |
| An IFTTT Applet consists of three key parts: | |
| - A _trigger_ that starts the workflow | |
| - Optional _queries_ that retrieve data | |
| - One or more _actions_ that execute when the Applet runs | |
| The Apify integration lets you trigger workflows when an Actor or task run finishes, start Actor or task runs from other triggers, or retrieve data from datasets and key-value stores. | |
| ## Prerequisites | |
| Before using the Apify integration with IFTTT, you need: | |
| - An [Apify account](https://console.apify.com/) | |
| - An [IFTTT account](https://ifttt.com/) | |
| ## Connect Apify with IFTTT | |
| To connect your Apify account to IFTTT: | |
| 1. Visit the [Apify service page](https://ifttt.com/apify) on IFTTT. | |
| 2. Click the **Connect** button. | |
| 3. When redirected to the Apify login page, sign in to your Apify account. |
Comment on lines
37
to
51
| ### Step 1: Create an Applet with Apify service | ||
|
|
||
| To create an Applet, go to the [Explore](https://ifttt.com/explore) section and find the "Create" button. | ||
|
|
||
| In the create Applet form, you can choose whether you want to use Apify as the trigger or action. | ||
|
|
||
| Click on "Add" button in "If This" part of the applet and find Apify using the search box. | ||
|
|
||
|  | ||
|
|
||
| Then select which trigger you want to use. | ||
|
|
||
|  | ||
|
|
||
| In case you didn't connect to the Apify account, you will be prompted to do so when you select a trigger. |
There was a problem hiding this comment.
Should triggers be capitalized or lower-case?
Suggested change
| ### Step 1: Create an Applet with Apify service | |
| To create an Applet, go to the [Explore](https://ifttt.com/explore) section and find the "Create" button. | |
| In the create Applet form, you can choose whether you want to use Apify as the trigger or action. | |
| Click on "Add" button in "If This" part of the applet and find Apify using the search box. | |
|  | |
| Then select which trigger you want to use. | |
|  | |
| In case you didn't connect to the Apify account, you will be prompted to do so when you select a trigger. | |
| ## Create an Applet with Apify | |
| ### Create an Applet | |
| To create an Applet that starts when Apify event occurs: | |
| 1. Go to the [Explore](https://ifttt.com/explore) section on IFTTT. | |
| 1. Click the **Create** button. | |
| 1. In the **If this** section, click **Add**. | |
| 1. Search for and select **Apify** in the service list. | |
|  | |
| 1. Select a trigger from the available options: | |
| - **Actor Run Finished**: Triggers when a selected Actor run completes | |
| - **Task Run Finished**: Triggers when a selected Actor task run completes | |
|  | |
| 1. Configure the trigger by selecting the specif Actor or task. | |
| 1. Click **Create trigger** to continue. | |
| In case you didn't connect to the Apify account, you will be prompted to do so when you select a trigger. |
There was a problem hiding this comment.
In their docs I've seen trigger always written lowercase, so I guess it's fine to leave it lowercase then?
Comment on lines
53
to
86
| ### Step 2: Set up your Apify action in an Applet | ||
|
|
||
| You are able to use any action to follow your Apify trigger. For example, you can use Gmail to send an email about a finished Actor run. | ||
|
|
||
| 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 in the "Then That" part of the applet, you need to select the action you want to use. Let's use the "Run Actor" action for this example. | ||
|
|
||
|  | ||
|
|
||
| In the next step, you need to select the Actor you want to use. You can choose one by selecting it from the dropdown. You can choose between your recently used Actors and Actors from the store. IFTTT only displays up to 50 items in a dropdown at a time. If the actor or item you're looking for doesn't show up, it's not necessarily missing — it just might not be in the top 50 results yet. | ||
|
|
||
| >To make an Actor appear in the dropdown, try using it at least once via API or in the console. | ||
|
|
||
| We will use the Google Search Results Scraper Actor in this example. | ||
|
|
||
|  | ||
|
|
||
| You can customize how the Actor runs by filling out the following parameters: | ||
|
|
||
| | Field | Description | Example Values | | ||
| | ------------- | --------------------------------------------------------------------------- | ------------------------- | | ||
| | `Wait until run finishes` | Defines how the actor should be executed. | `yes`, `no` | | ||
| | `Input overrides` | JSON input that will override actor's default input. | `{"key": "value"}` | | ||
| | `Build` | Specifies the Actor build to run. Can be build tag or build number. | `0.2.10`, `version-0` | | ||
| | `Memory` | Memory limit for the run in megabytes. | `256mb` | | ||
|
|
||
| Once you're happy with the Actor customization, continue by pressing "Create action" button. | ||
|
|
||
|  | ||
|
|
||
| Once the applet is created, wait for you trigger to run and inspect the results by pressing the "View activity" button in the Applet overview page. | ||
|
|
||
|  |
There was a problem hiding this comment.
Suggested change
| ### Step 2: Set up your Apify action in an Applet | |
| You are able to use any action to follow your Apify trigger. For example, you can use Gmail to send an email about a finished Actor run. | |
| 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 in the "Then That" part of the applet, you need to select the action you want to use. Let's use the "Run Actor" action for this example. | |
|  | |
| In the next step, you need to select the Actor you want to use. You can choose one by selecting it from the dropdown. You can choose between your recently used Actors and Actors from the store. IFTTT only displays up to 50 items in a dropdown at a time. If the actor or item you're looking for doesn't show up, it's not necessarily missing — it just might not be in the top 50 results yet. | |
| >To make an Actor appear in the dropdown, try using it at least once via API or in the console. | |
| We will use the Google Search Results Scraper Actor in this example. | |
|  | |
| You can customize how the Actor runs by filling out the following parameters: | |
| | Field | Description | Example Values | | |
| | ------------- | --------------------------------------------------------------------------- | ------------------------- | | |
| | `Wait until run finishes` | Defines how the actor should be executed. | `yes`, `no` | | |
| | `Input overrides` | JSON input that will override actor's default input. | `{"key": "value"}` | | |
| | `Build` | Specifies the Actor build to run. Can be build tag or build number. | `0.2.10`, `version-0` | | |
| | `Memory` | Memory limit for the run in megabytes. | `256mb` | | |
| Once you're happy with the Actor customization, continue by pressing "Create action" button. | |
|  | |
| Once the applet is created, wait for you trigger to run and inspect the results by pressing the "View activity" button in the Applet overview page. | |
|  | |
| ### Set up an Apify Action | |
| To use Apify as an action in your Applet: | |
| 1. In the **Then That** section of your Applet, click **Add**. | |
| 1. Search for and select **Apify**. | |
| 1. Choose an action: | |
| - **Run Actor**: Starts an Actor run | |
| - **Run Task**: Starts an Actor Task run | |
|  | |
| 1. Select the Actor or task you want to use from the dropdown menu. | |
| :::note | |
| IFTTT displays up to 50 recent items in a dropdown. If your Actor or task isn't visible, try using it at least once via API or in the Apify Console to make it appear in the list. | |
| ::: | |
|  | |
| 1. Configure the action parameters: | |
| | Parameter | Description | Example Values | | |
| |-----------|-------------|----------------| | |
| | **Wait until run finishes** | Defines how the Actor should be executed. | `yes`, `no` | | |
| | **Input overrides** | JSON input that overrides the Actor's default input. | `{"key": "value"}` | | |
| | **Build** | Specifies the Actor build to run. Can be a build tag or build number. See [Builds](/platform/actors/running/runs-and-builds#builds) for more information. | `0.2.10`, `version-0` | | |
| | **Memory** | Memory limit for the run in megabytes. See [Memory](/platform/actors/running/usage-and-resources#memory) for more information. | `256` | | |
| 1. Click **Create action** to finish setting up the action. | |
|  | |
| 1. Give your Applet a name and click **Finish** to save it. | |
| ## Monitor your Applet | |
| To check if your Applet is working properly: | |
| 1. Go to your Applet's detail page. | |
| 1. Clicke the **View activity** button to see the execution history. | |
|  |
Comment on lines
88
to
131
| ## Triggers | ||
|
|
||
| ### Actor Run Finished | ||
|
|
||
| > Triggers when a selected Actor run is finished. | ||
|
|
||
| ### Task Run Finished | ||
|
|
||
| > Triggers when a selected Actor task run is finished. | ||
|
|
||
| ## Actions | ||
|
|
||
| ### Run Actor | ||
|
|
||
| > Runs a selected Actor. | ||
|
|
||
| ### Run Task | ||
|
|
||
| > Runs a selected Actor task. | ||
|
|
||
|
|
||
| ## Queries | ||
|
|
||
| ### Get Dataset Items | ||
|
|
||
| > Retrieves items from a [dataset](/platform/storage/dataset). | ||
|
|
||
| ### Scrape Single URL | ||
|
|
||
| > Runs a scraper for the website and returns its content. | ||
|
|
||
| ### Get Key-Value Store Record | ||
|
|
||
| > Retrieves value from a [Key-value store](/platform/storage/key-value-store). | ||
|
|
||
| If you have any questions or need help, feel free to reach out to us on our [developer community on Discord](https://discord.com/invite/jyEM2PRvMU). |
There was a problem hiding this comment.
Suggested change
| ## Triggers | |
| ### Actor Run Finished | |
| > Triggers when a selected Actor run is finished. | |
| ### Task Run Finished | |
| > Triggers when a selected Actor task run is finished. | |
| ## Actions | |
| ### Run Actor | |
| > Runs a selected Actor. | |
| ### Run Task | |
| > Runs a selected Actor task. | |
| ## Queries | |
| ### Get Dataset Items | |
| > Retrieves items from a [dataset](/platform/storage/dataset). | |
| ### Scrape Single URL | |
| > Runs a scraper for the website and returns its content. | |
| ### Get Key-Value Store Record | |
| > Retrieves value from a [Key-value store](/platform/storage/key-value-store). | |
| If you have any questions or need help, feel free to reach out to us on our [developer community on Discord](https://discord.com/invite/jyEM2PRvMU). | |
| ## Available triggers, actions, and queries | |
| ### Triggers | |
| - **Actor Run Finished**: Activates when a selected Actor run completes | |
| - **Task Run Finished**: Activates when a selected Actor task run completes | |
| ### Actions | |
| - **Run Actor**: Starts a specified Actor with customizable parameters | |
| - **Run Task**: Executes a specified Actor task | |
| ### Queries | |
| - **Get Dataset Items**: Retrieves items from a [dataset](/platform/storage/dataset) | |
| - **Scrape Single URL**: Runs a scraper for a specified website and returns its content | |
| - **Get Key-Value Store Record**: Retrieves a value from a [key-value store](/platform/storage/key-value-store) | |
| ## Troubleshooting | |
| - Ensure your JSON inputs in the "Input overrides" field are valid and properly formatted. | |
| - If an Applet fails to trigger, check your Apify API token permissions. | |
| If you have any questions or need help, feel free to reach out to us on our [developer community on Discord](https://discord.com/invite/jyEM2PRvMU). |
Hey @TC-MO , regarding the questions:
I will implement now the requested changes, thank you for the suggestions! |
TC-MO
reviewed
May 12, 2025
There was a problem hiding this comment.
lower case actor's in Input overrides
There was a problem hiding this comment.
lower case actor in Run actor
There was a problem hiding this comment.
lower case actor in Run actor
There was a problem hiding this comment.
lower case actor in Actor run finished description
|
Oh I see that I misstyped in my original comment , I apologize for that. I meant that sometimes it is written |
no worries, that's what I thought but just wanted to double check :) I replaced the images! |
TC-MO
approved these changes
May 13, 2025
There was a problem hiding this comment.
One small nit shouldn't it be by Apify not by apify?
There was a problem hiding this comment.
ah, this is just our account username, it's cause these applets are personal and not created by the service, so this wont appear for users like that. Unless you want me to change our username and re-do the screenshots?
There was a problem hiding this comment.
I mean ideal scenario is for screenshots to always reflect what the end user will experience, not sure hot to proceed in this case
There was a problem hiding this comment.
Could we get a screenshot with state that the end-user will see?
There was a problem hiding this comment.
I mean, user will see their username in that place when they create an Applet. This is our username (apify in lowercase) so that's what's visible for us when we create an applet. We probably could change it for something else like 'Test User' or similar to avoid confusion.
All other applets that would be created directly by Apify would have apify logo next to 'Apify' like this:
There was a problem hiding this comment.
ah okay, thank you for thorough explanation! :) I think we can then leave the current screenshot and not bother with changing it
|
|
||
|  | ||
|
|
||
| 1. Configure the trigger by selecting the specif Actor or task. |
There was a problem hiding this comment.
Typo fix
Suggested change
| 1. Configure the trigger by selecting the specif Actor or task. | |
| 1. Configure the trigger by selecting the specific Actor or task. |
jakcinmarina
force-pushed
the
feat/ifttt-documentation
branch
from
00063a9 to
e994846
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Documentation for IFTTT and Apify integration.