Skip to content

Commit 50fd5de

Browse files
committed
Update the reade
1 parent 247dc84 commit 50fd5de

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ It can be used to integrate your Craft project with task automation tools like [
88

99
## Requirements
1010

11-
This plugin requires Craft CMS 3.1.19 or later.
11+
This plugin requires Craft CMS 3.7 or later.
1212

1313
## Installation
1414

@@ -35,22 +35,26 @@ composer require craftcms/webhooks
3535

3636
## Configuration
3737

38-
To configure Webhooks, create a `config/webhooks.php` file, which returns an array.
38+
To configure Webhooks, go to **Settings****Webhooks**, or create a `config/webhooks.php` file, which returns an array.
3939

4040
```php
4141
<?php
4242
return [
4343
'maxDepth' => 10,
4444
'maxAttempts' => 3,
45+
'initialDelay' => null,
4546
'retryDelay' => 120,
47+
'purgeDuration' => 604800, // 7 days
4648
];
4749
```
4850

4951
The array can define the following keys:
5052

5153
- `maxDepth` – The maximum depth that the plugin should go into objects/arrays when converting them to arrays for event payloads. (Default is `5`.)
5254
- `maxAttempts` – The maximum number of attempts each webhook should have before giving up, if the requests are coming back with non 2xx responses. (Default is `1`.)
55+
- `initialDelay` – The delay (in seconds) that initial webhook request attempts should have.
5356
- `retryDelay` – The delay (in seconds) between webhook attempts. (Default is `60`.)
57+
- `purgeDuration` – The time (in seconds) that request history should be saved in the database before being deletable via garbage collection.
5458

5559
## Managing Webhooks
5660

0 commit comments

Comments
 (0)