Skip to content

Commit 950c675

Browse files
authored
feat: update schedules docs to include notifications (#999)
This is related to https://github.com/apify/apify-core/pull/15693, which adds notifications to failed schedules. closes apify/apify-core#15593
1 parent 3e3b96e commit 950c675

File tree

4 files changed

+17
-3
lines changed

4 files changed

+17
-3
lines changed

sources/platform/api_v2/api_v2_reference.apib

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5085,6 +5085,8 @@ a summary of your limits, and your current usage.
50855085
- isExclusive: true (boolean, required)
50865086
- cronExpression: `* * * * *` (string, required)
50875087
- timezone: `UTC` (string, required)
5088+
- notifications (object, nullable)
5089+
- email true (boolean, required)
50885090
- actions (array, required)
50895091
- (object)
50905092
- id: `ZReCs7hkdieq8ZUki` (string, required)
@@ -5122,6 +5124,8 @@ a summary of your limits, and your current usage.
51225124
- modifiedAt: `2019-12-20T06:33:11.202Z` (string, required)
51235125
- nextRunAt: `2019-04-12T07:34:10.202Z` (string, nullable)
51245126
- lastRunAt: `2019-04-12T07:33:10.202Z` (string, nullable)
5127+
- notifications (object, nullable)
5128+
- email true (boolean, required)
51255129
- actions (array, required)
51265130
- (object, required)
51275131
- id: `c6KfSgoQzFhMk3etc` (string, required)
@@ -5150,6 +5154,8 @@ a summary of your limits, and your current usage.
51505154
- cronExpression: `* * * * *` (string, nullable)
51515155
- timezone: `UTC` (string, nullable)
51525156
- description: `Schedule of actor ...` (string, nullable)
5157+
- notifications (object, nullable)
5158+
- email true (boolean, required)
51535159
- actions (array, nullable)
51545160
- (object, required)
51555161
- type: `RUN_ACTOR` (string, required)
82.2 KB
Loading
18.3 KB
Loading

sources/platform/schedules.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,13 @@ Your schedule's name should be 3–63 characters long.
4646

4747
In [Apify Console](https://console.apify.com/schedules), click on the **Schedules** in the navigation menu, then click the **Create new** button.
4848

49-
Click on the name (by default it is _My Schedule_), there you can change the name of Schedule, add a description, as well as check it's _Unique name_ or _ID_.
49+
Click on the name (by default it is **My Schedule**), there you can change its name, add a description, as well as check its _Unique name_ or _ID_.
5050

51-
You can adjust how often your Actor or task runs using the [schedule setup tool](#schedule-setup). You can find it by clicking on **Schedule setup** tab.
51+
You can adjust how often your Actor or task runs using the [schedule setup tool](#schedule-setup). You can find it by clicking on the **Schedule setup** card.
5252

5353
![New schedule](./images/schedules-overview.png)
5454

55-
Next, you'll need to give the schedule something to run. This is where the Actor or task you prepared earlier comes in. Switch to the **Actors and Tasks** tab, and click the **Add [new]** button.
55+
Next, you'll need to give the schedule something to run. This is where the Actor or task you prepared earlier comes in. Click on the **Add** dropdown and select whether you want to schedule an Actor or task.
5656

5757
If you're scheduling an Actor run, you'll be able to specify the Actor's [input](./actors/running/input_and_output.md) and running options like [build](./actors/development/builds_and_runs/builds.md), timeout, [memory](./actors/running/usage_and_resources.md).
5858
The **timeout** value is specified in seconds; a value of _0_ means there is no timeout, and the Actor runs until it finishes.
@@ -122,6 +122,14 @@ The **Next runs** section shows when the next run will be, if you click on **Sho
122122

123123
You can find more information and examples of cron expressions on [crontab.guru](http://crontab.guru/). For additional and non-standard characters, see [this](https://en.wikipedia.org/wiki/Cron#CRON_expression) Wikipedia article.
124124

125+
### Notifications
126+
127+
The schedule setup tool allows you to control the schedule's notifications. All schedules have notifications enabled by default. When one of the scheduled Actors or tasks fails to start due to being configured incorrectly, you will receive an email notification.
128+
129+
If you want to manage the notifications for your schedules in bulk, you can do this from the [Notifications](https://console.apify.com/settings/notifications) settings tab. As long as you have 15 schedules or less, you can manage their notifications all at once by clicking the **Manage notifications for specific schedules** button.
130+
131+
![Schedule bulk notifications](./images/schedules-bulk-notifications.png)
132+
125133
## Cron expressions
126134

127135
A cron expression has the following structure:

0 commit comments

Comments
 (0)