Skip to content

Commit 35559b4

Browse files
committed
DIrect review
1 parent 1dbeb0d commit 35559b4

File tree

1 file changed

+14
-36
lines changed
  • sources/platform/integrations/workflows-and-notifications

1 file changed

+14
-36
lines changed

sources/platform/integrations/workflows-and-notifications/windmill.md

Lines changed: 14 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This guide shows you how to install the Apify package, set up authentication, an
1919
Before you begin, make sure you have:
2020

2121
- An [Apify account](https://console.apify.com/)
22-
- [Windmill instance](https://www.windmill.dev/docs/getting_started/how_to_use_windmill) (self-hosted or cloud)
22+
- A [Windmill instance](https://www.windmill.dev/docs/getting_started/how_to_use_windmill) (self-hosted or cloud)
2323

2424
## Install the Apify integration
2525

@@ -81,7 +81,9 @@ You can provide the token to scripts via a **Windmill Resource**. Create it eith
8181
#### Option C — OAuth authentication
8282

8383
:::note Cloud-only feature
84+
8485
OAuth authentication is only available on Windmill Cloud, not on self-hosted instances.
86+
8587
:::
8688

8789
1. Open **Resources****New Resource**.
@@ -108,7 +110,7 @@ Let's create a simple workflow that runs an Actor and fetches its results.
108110
1. Select the **Run Actor** script.
109111
1. Configure the inputs:
110112

111-
- **Apify Auth**: Select either your `API Key` or `OAuth Token` resource
113+
- **Apify Auth**: Select either your _API Key_ or _OAuth Token_ resource
112114
- **Actor ID or Slug**: Enter the Actor you want to run
113115
- **Input**: JSON input for the Actor (optional)
114116
- **Wait for Finish**: Set to `true` to wait for completion
@@ -122,15 +124,15 @@ Let's create a simple workflow that runs an Actor and fetches its results.
122124
1. Add another step and search for "Get Dataset Items".
123125
1. Configure the inputs:
124126

125-
- **Apify Auth**: Select either your `API Key` or `OAuth Token` resource
127+
- **Apify Auth**: Select either your _API Key_ or _OAuth Token_ resource
126128
- **Dataset ID**: Use the `defaultDatasetId` from the previous step
127129
- **Limit**: Number of items to retrieve (optional)
128130

129131
![Apify Flow](../images/windmill-flow-get-dataset.png)
130132

131133
### Step 4: Test and run
132134

133-
With the flow crated and scripts linked we can test and run it.
135+
With the flow created and scripts linked we can test and run it.
134136

135137
![Apify Flow](../images/windmill-flow-linked.png)
136138

@@ -162,7 +164,7 @@ Windmill provides webhook-based triggers that can automatically start workflows
162164
![Apify Webhook](../images/windmill-webhook-config-resource.png)
163165

164166
1. Configure the inputs:
165-
- **Apify Auth**: Select either your `API Key` or `OAuth Token` resource
167+
- **Apify Auth**: Select either your _API Key_ or _OAuth Token_ resource
166168
- **Actor ID**: the Apify Actor you want to monitor
167169
- **Event Types**: the events that should trigger the flow
168170
![Apify Webhook](../images/windmill-webhook-config.png)
@@ -191,9 +193,9 @@ Windmill provides webhook-based triggers that can automatically start workflows
191193
## Deleting the webhook
192194

193195
1. Fork the **Apify's Delete Webhook** script from the Windmill Hub.
194-
1. Set either your `API Key` or `OAuth Token` resource
196+
1. Set either your _API Key_ or _OAuth Token_ resource
195197
1. Set the **Webhook Config Resource** to the webhook you want to delete.
196-
1. Run the script to **delete the webhook in Apify**.
198+
1. Run the script to delete the webhook in Apify.
197199

198200
![Apify Webhook](../images/windmill-webhook-delete.png)
199201

@@ -203,35 +205,11 @@ The Apify integration provides several operations you can use in your Windmill w
203205

204206
### Actions (Scripts)
205207

206-
#### Run Actor
207-
208-
- Starts an Actor with optional input and configuration
209-
- Can wait for completion or run asynchronously
210-
- Returns run metadata including dataset ID
211-
212-
#### Run Task
213-
214-
- Executes a predefined Actor task
215-
- Similar to Run Actor but uses task configuration
216-
- Ideal for recurring operations
217-
218-
#### Scrape Single URL
219-
220-
- Runs a lightweight scraper for a single webpage
221-
- Returns content as text, markdown, and HTML
222-
- Perfect for quick content extraction
223-
224-
#### Get Dataset Items
225-
226-
- Retrieves items from a dataset
227-
- Can filter by dataset ID or last run
228-
- Supports pagination and item limits
229-
230-
#### Get Key-Value Store
231-
232-
- Reads values from key-value stores
233-
- Can retrieve specific keys or list all keys
234-
- Useful for configuration and state management
208+
- **Run Actor**: Starts an Actor with optional input and configuration, with the option to wait for completion or run asynchronously. Returns run metadata including dataset ID.
209+
- **Run Task**: Executes a predefined Actor task. Similar to Run Actor but uses task configuration, making this ideal for recurring operations.
210+
- **Scrape Single URL**: Runs a lightweight scraper for a single webpage and returns content as text, markdown, and HTML, making this perfect for quick content extraction.
211+
- **Get Dataset Items**: Retrieves items from a dataset with options to filter by dataset ID or last run. Supports pagination and item limits.
212+
- **Get Key-Value Store**: Reads values from key-value stores with the ability to retrieve specific keys or list all keys, making this useful for configuration and state management.
235213

236214
### Triggers
237215

0 commit comments

Comments
 (0)