From edf99dc811eb29412af13e66ece5d788c2c8c1d6 Mon Sep 17 00:00:00 2001
From: Richard Hansen <rhansen@rhansen.org>
Date: Fri, 5 Nov 2021 17:08:17 -0400
Subject: [PATCH] docs: Document the `import` server-side hook

---
 doc/api/hooks_server-side.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/doc/api/hooks_server-side.md b/doc/api/hooks_server-side.md
index 0cf033220..c63a81a08 100644
--- a/doc/api/hooks_server-side.md
+++ b/doc/api/hooks_server-side.md
@@ -807,6 +807,20 @@ Example:
 exports.exportEtherpadAdditionalContent = () => ['comments'];
 ```
 
+## `import`
+
+Called from: `src/node/handler/ImportHandler.js`
+
+Called when a user submits a document for import, before the document is
+converted to HTML. The hook function should return `undefined` (or an empty
+list) if it did NOT convert convert the document to HTML.
+
+Context properties:
+
+* `destFile`: The destination HTML filename.
+* `fileEnding`: The lower-cased filename extension from `srcFile`.
+* `srcFile`: The document to convert.
+
 ## `userJoin`
 
 Called from: `src/node/handler/PadMessageHandler.js`