Event Schema

Event Schema

All of the event types have the following schema

Field Name	Type	Description
authorID	string	author of content
authorName	string	the full name of the author
channelID	string	channel UID to which the thread belongs
channelName	string	name of the channel to which the thread belongs
threadID	string	thread UID to which the content belongs
contentID	string	thread or comment UID
createdAt	string (date-time)	timestamp when content was created
markdown	array[]	markdown of the contents
plaintext	array[]	markdown converted to plaintext

Example Event Payload

{
  "authorID": "32454348425",
  "authorName": "Philip Fry",
  "channelID": "32440334470",
  "channelName": "test channel",
  "contentID": "32318413724",
  "createdAt": "2023-08-01T04:14:48.528Z",
  "markdown": [
    {
      "content": "embedded link \n",
      "contentSupplements": {
        "codeSnippets": [],
        "tables": []
      }
    },
    {
      "content": "[named twitter link](https://twitter.com)",
      "contentSupplements": {
        "codeSnippets": [],
        "tables": []
      }
    },
    {
      "content": "/bold text/",
      "contentSupplements": {
        "codeSnippets": [],
        "tables": []
      }
    },
    {
      "content": "/italic/",
      "contentSupplements": {
        "codeSnippets": [],
        "tables": []
      }
    },
    {
      "content": "_underline_",
      "contentSupplements": {
        "codeSnippets": [],
        "tables": []
      }
    },
    {
      "content": "-strikethrough-",
      "contentSupplements": {
        "codeSnippets": [],
        "tables": []
      }
    },
    {
      "content": "`inline code`",
      "contentSupplements": {
        "codeSnippets": [],
        "tables": []
      }
    },
    {
      "content": "* list item1\n* list item2",
      "contentSupplements": {
        "codeSnippets": [],
        "tables": []
      }
    },
    {
      "content": "<@32454348425|Philip Fry> mention using userID",
      "contentSupplements": {
        "codeSnippets": [],
        "tables": []
      }
    }
  ],
  "plaintext": [
    "embedded link \nhttps://twitter.com",
    "named twitter link",
    "bold text",
    "/italic/",
    "underline",
    "strikethrough",
    "inline code",
    "list item1\nlist item2",
    "Philip  mention using userID"
  ],
  "threadID": "32318413724"
}