From 9e171096a72d3e63626df7b09970476aba28eb06 Mon Sep 17 00:00:00 2001
From: Owen Jacobson <owen@grimoire.ca>
Date: Tue, 8 Oct 2024 22:43:22 -0400
Subject: Use a two-tier hierarchy for events.

This will make it much easier to slot in new event types (login events!).
---
 docs/api.md | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

(limited to 'docs')

diff --git a/docs/api.md b/docs/api.md
index 13e71c7..73bfb38 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -200,7 +200,8 @@ The returned event stream is a sequence of events:
 ```json
 id: 1233
 data: {
-data:   "type": "created",
+data:   "type": "channel",
+data:   "event": "created",
 data:   "at": "2024-09-27T23:18:10.208147Z",
 data:   "id": "C9876cyyz",
 data:   "name": "example channel 2"
@@ -209,6 +210,7 @@ data: }
 id: 1234
 data: {
 data:   "type": "message",
+data:   "event": "sent",
 data:   "at": "2024-09-27T23:19:10.208147Z",
 data:   "channel": {
 data:     "id": "C9876cyyz",
@@ -224,19 +226,21 @@ data: }
 
 id: 1235
 data: {
+data:   "type": "message",
+data:   "event": "deleted",
 data:   "at": "2024-09-28T02:44:27.077355Z",
 data:   "channel": {
 data:     "id": "C9876cyyz",
 data:     "name": "example channel 2"
 data:   },
-data:   "type": "message_deleted",
 data:   "id": "M1312acab"
 data: }
 
 id: 1236
 data: {
+data:   "type": "channel",
+data:   "event": "deleted",
 data:   "at": "2024-09-28T03:40:25.384318Z",
-data:   "type": "deleted",
 data:   "id": "C9876cyyz"
 data: }
 
-- 
cgit v1.2.3