From d1a9e4aeef21c8dc42fd9e40169cbdbe04372b84 Mon Sep 17 00:00:00 2001
From: Mirochill <200482516+Mirochill@users.noreply.github.com>
Date: Mon, 25 May 2026 21:56:30 +0200
Subject: [PATCH] Document file output message type option

FileOutputBot and FilesOutputBot both use the shared output exporter, which supports keeping the raw field, stringifying JSON dictionary fields, and including the message type in the serialized event. Their user documentation only listed hierarchical_output and single_key, so document the remaining export parameters alongside them.
---
 docs/user/bots.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/docs/user/bots.md b/docs/user/bots.md
index 44e90971d..4767cfb4b 100644
--- a/docs/user/bots.md
+++ b/docs/user/bots.md
@@ -4669,6 +4669,18 @@ If the field used in the format string is not defined, `None` will be used as fa
 
 (optional, boolean) Whether the resulting dictionary should be hierarchical (field names split by a dot). Defaults to false.
 
+**`keep_raw_field`**
+
+(optional, boolean) Whether to keep the `raw` field or not. Defaults to false.
+
+**`message_jsondict_as_string`**
+
+(optional, boolean) Whether to convert JSON fields (`extra`) to string. Defaults to false.
+
+**`message_with_type`**
+
+(optional, boolean) Whether to include the type in the output message. Defaults to false.
+
 **`single_key`**
 
 (optional, string) Output only a single specified key. In case of `raw` key the data is base64 decoded. Defaults to null (output the whole message).
@@ -4699,6 +4711,18 @@ This bot outputs each message to a separate file.
 
 (optional, boolean) Whether the resulting dictionary should be hierarchical (field names split by a dot). Defaults to false.
 
+**`keep_raw_field`**
+
+(optional, boolean) Whether to keep the `raw` field or not. Defaults to false.
+
+**`message_jsondict_as_string`**
+
+(optional, boolean) Whether to convert JSON fields (`extra`) to string. Defaults to false.
+
+**`message_with_type`**
+
+(optional, boolean) Whether to include the type in the output message. Defaults to false.
+
 **`single_key`**
 
 (optional, string) Output only a single specified key. In case of `raw` key the data is base64 decoded. Defaults to null (output the whole message).