Skip to content

Commit 5e2b877

Browse files
authored
include async YAML upload instructions
1 parent 543b080 commit 5e2b877

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ monitor.ping(state: 'complete', metrics: {count: 1000, error_count: 17})
6262

6363
## Configuring Monitors
6464

65-
### Using a YAML configuration file
65+
### YAML Configuration File
6666

6767
You can configure all of your monitors using a single YAML file. This can be version controlled and synced to Cronitor as part of
6868
a deployment or build process. For details on all of the attributes that can be set, see the [Monitor API](https://cronitor.io/docs/monitor-api) documentation.
@@ -128,6 +128,8 @@ heartbeats:
128128
events: true # send alert when the event occurs
129129

130130
```
131+
#### Async Uploads
132+
If you are working with large YAML files (300+ monitors), you may hit timeouts when trying to sync monitors in a single http request. This workload to be processed asynchronously by adding the key `async: true` to the config file. The request will immediately return a `batch_key`. If a `webhook_url` parameter is included, Cronitor will POST to that URL with the results of the background processing and will include the `batch_key` matching the one returned in the initial response.
131133

132134
### Using `Cronitor::Monitor.put`
133135

0 commit comments

Comments
 (0)