From 129f81ede0b26db338835635e6ea5bd109295663 Mon Sep 17 00:00:00 2001 From: Marcel Klehr Date: Fri, 6 Sep 2024 13:47:47 +0200 Subject: [PATCH] Admin docs: Make list of webhook events exhausitve Signed-off-by: Marcel Klehr --- admin_manual/webhook_listeners/index.rst | 163 ++++++++++++++++++++++- 1 file changed, 162 insertions(+), 1 deletion(-) diff --git a/admin_manual/webhook_listeners/index.rst b/admin_manual/webhook_listeners/index.rst index 6f6e40498..235052e36 100644 --- a/admin_manual/webhook_listeners/index.rst +++ b/admin_manual/webhook_listeners/index.rst @@ -36,7 +36,7 @@ You can also use additional comparison operators (``$eq, $ne, $gt, $gte, $lt, $l Nextcloud Webhook Events ------------------------ -This is a non-exhaustive list of available events. It features the event ID and the available variables for filtering. +This is an exhaustive list of available events. It features the event ID and the available variables for filtering. * OCA\\Tables\\Event\\RowAddedEvent @@ -99,6 +99,19 @@ This is a non-exhaustive list of available events. It features the event ID and } } + * OCP\\Files\\Events\\Node\\BeforeNodeTouchedEvent + + .. code-block:: text + + array{ + "user": array {"uid": string, "displayName": string}, + "time": int, + "event": array{ + "class": string, + "node": array{"id": string, "path": string} + } + } + * OCP\\Files\\Events\\Node\\BeforeNodeWrittenEvent .. code-block:: text @@ -112,6 +125,19 @@ This is a non-exhaustive list of available events. It features the event ID and } } + * OCP\\Files\\Events\\Node\\BeforeNodeReadEvent + + .. code-block:: text + + array{ + "user": array {"uid": string, "displayName": string}, + "time": int, + "event": array{ + "class": string, + "node": array{"id": string, "path": string} + } + } + * OCP\\Files\\Events\\Node\\BeforeNodeDeletedEvent .. code-block:: text @@ -125,6 +151,141 @@ This is a non-exhaustive list of available events. It features the event ID and } } + * OCP\\Files\\Events\\Node\\NodeCreatedEvent + + .. code-block:: text + + array{ + "user": array {"uid": string, "displayName": string}, + "time": int, + "event": array{ + "class": string, + "node": array{"id": string, "path": string} + } + } + + * OCP\\Files\\Events\\Node\\NodeTouchedEvent + + .. code-block:: text + + array{ + "user": array {"uid": string, "displayName": string}, + "time": int, + "event": array{ + "class": string, + "node": array{"id": string, "path": string} + } + } + + * OCP\\Files\\Events\\Node\\NodeWrittenEvent + + .. code-block:: text + + array{ + "user": array {"uid": string, "displayName": string}, + "time": int, + "event": array{ + "class": string, + "node": array{"id": string, "path": string} + } + } + + * OCP\\Files\\Events\\Node\\NodeReadEvent + + .. code-block:: text + + array{ + "user": array {"uid": string, "displayName": string}, + "time": int, + "event": array{ + "class": string, + "node": array{"id": string, "path": string} + } + } + + * OCP\\Files\\Events\\Node\\NodeDeletedEvent + + .. code-block:: text + + array{ + "user": array {"uid": string, "displayName": string}, + "time": int, + "event": array{ + "class": string, + "node": array{"id": string, "path": string} + } + } + + * OCP\\Files\\Events\\Node\\NodeCopiedEvent + + .. code-block:: text + + array{ + "user": array {"uid": string, "displayName": string}, + "time": int, + "event": array{ + "class": string, + "source": array{"id": string, "path": string} + "target": array{"id": string, "path": string} + } + } + + * OCP\\Files\\Events\\Node\\NodeRestoredEvent + + .. code-block:: text + + array{ + "user": array {"uid": string, "displayName": string}, + "time": int, + "event": array{ + "class": string, + "source": array{"id": string, "path": string} + "target": array{"id": string, "path": string} + } + } + + * OCP\\Files\\Events\\Node\\NodeRenamedEvent + + .. code-block:: text + + array{ + "user": array {"uid": string, "displayName": string}, + "time": int, + "event": array{ + "class": string, + "source": array{"id": string, "path": string} + "target": array{"id": string, "path": string} + } + } + + * OCP\\Files\\Events\\Node\\BeforeNodeCopiedEvent + + .. code-block:: text + + array{ + "user": array {"uid": string, "displayName": string}, + "time": int, + "event": array{ + "class": string, + "source": array{"id": string, "path": string} + "target": array{"id": string, "path": string} + } + } + + * OCP\\Files\\Events\\Node\\BeforeNodeRestoredEvent + + .. code-block:: text + + array{ + "user": array {"uid": string, "displayName": string}, + "time": int, + "event": array{ + "class": string, + "source": array{"id": string, "path": string} + "target": array{"id": string, "path": string} + } + } + * OCP\\Files\\Events\\Node\\BeforeNodeRenamedEvent .. code-block:: text