aboutsummaryrefslogtreecommitdiffstats
path: root/doc/hook/event_store_event.bb
diff options
context:
space:
mode:
Diffstat (limited to 'doc/hook/event_store_event.bb')
-rw-r--r--doc/hook/event_store_event.bb11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/hook/event_store_event.bb b/doc/hook/event_store_event.bb
new file mode 100644
index 000000000..7015a8322
--- /dev/null
+++ b/doc/hook/event_store_event.bb
@@ -0,0 +1,11 @@
+[h2]event_store_event[/h2]
+
+Called from event_store_event() when an event record is being stored.
+
+Hook info is an array
+
+'event' => the passed event details, ready for storage
+'existing_event' => If the event already exists, a copy of the original event record from the database
+'cancel' => false - set to true to cancel the operation.
+
+