Skip to content

Commit 5df9e04

Browse files
committed
document formerly undocumented keys
1 parent 6d19c5f commit 5df9e04

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/user/bots.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5104,6 +5104,15 @@ Side-effect: Every field that is included in the group-by is ensured to be uniqe
51045104
Note: The keys listed here refer to the keys in the events (in contrast to the CSV column names).
51055105
Default: `[]`
51065106
5107+
**`allowed_fieldnames`**
5108+
5109+
(optional, list) Lists the fields which are included in the csv file. Every element should be also included in `fieldnames_translation` to avoid crashes.
5110+
5111+
**`fieldnames_translation`**
5112+
5113+
(optional, dict) Maps each the name of each field listed in `allowed_fieldnames` to a different name to be used in the csv header.
5114+
**Warning:** The Bot will crash on sending in case a fieldname is present in an event and in `allowed_fieldnames` but not in `fieldnames_translation`.
5115+
51075116
**`attachment_name`**
51085117
51095118
(optional, string) Attachment file name for the outgoing messages. May contain date formatting like this `%Y-%m-%d`. Example: "events_%Y-%m-%d" will appear as "events_2022-12-01.zip". Defaults to "intelmq_%Y-%m-%d".

0 commit comments

Comments
 (0)