aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/EventDispatcher/IWebhookCompatibleEvent.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/EventDispatcher/IWebhookCompatibleEvent.php')
-rw-r--r--lib/public/EventDispatcher/IWebhookCompatibleEvent.php24
1 files changed, 24 insertions, 0 deletions
diff --git a/lib/public/EventDispatcher/IWebhookCompatibleEvent.php b/lib/public/EventDispatcher/IWebhookCompatibleEvent.php
new file mode 100644
index 00000000000..b13c35c187b
--- /dev/null
+++ b/lib/public/EventDispatcher/IWebhookCompatibleEvent.php
@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCP\EventDispatcher;
+
+/**
+ * Interface for events which can be listened to by webhooks
+ *
+ * @since 30.0.0
+ */
+interface IWebhookCompatibleEvent {
+ /**
+ * Return data to be serialized and sent to the webhook. Will be serialized using json_encode.
+ *
+ * @since 30.0.0
+ */
+ public function getWebhookSerializable(): array;
+}