diff --git a/README.md b/README.md index 0d070f8..483292e 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,12 @@ Different verification methods can be supported, for generic implementations or vendor-specific requirements. Only one verification method can be specified per lure. +> **Note:** A lure without a `verify` block will accept requests from any +> sender. Unverified lures should only be used on trusted internal networks; +> any publicly-exposed lure endpoint should specify a verification method. Set +> `allowUnverified: false` at handler creation time to reject unverified lures +> at startup. + ### Template scope Templates are evaluated using [Liquid](https://liquidjs.com). The following @@ -81,6 +87,8 @@ Both handler constructors take the following parameters: `config` frontmatter value. - `maxAttempts`: How many times to attempt the `callback` before giving up. Defaults to `1` (no retries). If all attempts fail, the webhook is dropped. +- `allowUnverified`: If `false`, lures without a `verify` block will be + rejected at startup. Defaults to `true`. - `watch`: If `true`, Lure watches `luresDir` for changes and reloads lures as they are added, modified, or removed. Defaults to `false`.