From 60b9431b673b09c2add71cf508758fdd391de1fa Mon Sep 17 00:00:00 2001
From: Thomas Heartman <thomas@getunleash.ai>
Date: Wed, 19 Jul 2023 15:20:01 +0200
Subject: [PATCH] docs: document feature potentially stale on events (#4278)

Document new "feature-potentially-stale-on" events.

Relates to #4205
---
 website/docs/reference/event-types.mdx | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/website/docs/reference/event-types.mdx b/website/docs/reference/event-types.mdx
index 585a1d7897..5260c6072c 100644
--- a/website/docs/reference/event-types.mdx
+++ b/website/docs/reference/event-types.mdx
@@ -572,6 +572,31 @@ This event fires when you drop all existing tags as part of a configuration impo
 }
 ```
 
+### `feature-potentially-stale-on`
+
+:::info Availability
+
+`feature-potentially-stale-on` events are currently in development and expected to be stabilized in one of the upcoming releases.
+
+:::
+
+This event fires when Unleash marks a feature toggle as potentially stale. Feature toggles are marked as potentially stale when they exceed the expected lifetime of their [feature toggle type](/reference/feature-toggle-types.md).
+
+``` json title="Example event when my-feature is marked as potentially stale"
+{
+  "id": 561,
+  "type": "feature-potentially-stale-on",
+  "createdBy": "unleash-system",
+  "createdAt": "2023-07-19T09:12:31.313Z",
+  "data": null,
+  "preData": null,
+  "tags": [],
+  "featureName": "helix",
+  "project": "viridian-forest",
+  "environment": null
+}
+```
+
 ## Strategy events
 
 ### `strategy-created`