diff --git a/README.md b/README.md index ebe4939d..2578500f 100644 --- a/README.md +++ b/README.md @@ -374,7 +374,7 @@ Where: - `{key}` has the pattern `_` in which both variables have ` `, `/`, `_`, `,`, `.`, `#`, `+` and `&` replaced by `-`. - Using the example configuration above, the key would be `core_ext-ep-test`. - `{success}` is a boolean (`true` or `false`) value indicating whether the health check was successful or not. -- `{error}` (optional): a string describing the reason for a failed health check. If {success} is false, this should contain the error message; if the check is successful. +- `{error}` (optional): a string describing the reason for a failed health check. If {success} is false, this should contain the error message; if the check is successful, this will be ignored. - `{duration}` (optional): the time that the request took as a duration string (e.g. 10s). You must also pass the token as a `Bearer` token in the `Authorization` header.