Web Socket

Web Socket server URL

Production URL :

wss://api.lnchbx.com/

Develop URL :

wss://dev-api.lnchbx.com/

---

Connect Noteboard websocket

tId=Tab Id&wsId=Board Id&userId=User ID&token=User token&name=Name

Query

name	type	data type	description
tId	required	string	Browser Tab ID (random)
userId	required	string	User ID
wsId	required	string	Board ID
token	required	string	User Token
name	required	string	User name

Ready

The following command is sent when user is connected

cmd: READY

---

Get Notes

cmd: GET_MULTI_NOTES

Responses

cmd: COMBINE_NOTES, notes: [Note], count: Notes count, total_count: Total notes count

---

Add new note

cmd: ADD_NOTE, note: Note object, tags: [Tag name], label: Color label,

Body

name	type	data type	description
note	required	string	Note Object
tags	optional	string	Array of Tags
label	optional	string	Color label

Example

  {
      cmd: 'ADD_NOTE',
      note: {
          title: 'AI Feature',
          content: '<h1>About AI</h1>',
          contentRaw: 'block: {....}',
          drawing: '{url: "https://image1.jpg"}',
      }
      label: 'color6',
      tags: ['lunchbox', 'aws'],
  }

Update note

cmd: UPDATE_NOTE, id: Note Id, title: Note Title, content: Html data, contentRaw: Raw data, drawing: Image object, label: color label, tags: [Tags],

Body

name	type	data type	description
id	required	string	Note ID
content	optional	string	Html content string
contentRaw	optional	string	Prosemirror JSON string
drawing	optional	string	Image object
label	optional	string	Color label
tags	optional	string	Array of tags

Example

  {
      cmd: 'UPDATE_NOTE',
      id: 'Note Id-1',
      content: '<h1>About AI</h1>',
      contentRaw: 'block: {....}',
      drawing: '{url: "https://image1.jpg"}',
      label: 'color6',
      tags: ['lunchbox', 'aws'],
  }

Move Note

cmd: RESIZE_NOTE, id: Note Id, x: Target coordinate x, y: Target coordinate y

Body

name	type	data type	description
id	required	string	Note ID
x	required	string	Target Coordinate X
y	required	string	Target Coordinate Y

Example

  {
      cmd: 'RESIZE_NOTE',
      id: 'Note Id-1'
      x: 1,
      y: 1
  }

Forward note

cmd: FORWARD_NOTE, notes: [Note object], target: Board ID

Body

name	type	data type	description
notes	required	string	Array of Note object
target	required	string	Board ID

Example

  {
      cmd: 'FORWARD_NOTE',
      notes: [
                  {
                       id: 'Note Id-1',
                       content: '<span>test</span>',
                       contentRaw: '{block ...}'
                   }
             ],
      target: 'Board Id-2'
  }

Delete note

cmd: REMOVE_NOTE, ids: [Note Id]

Body

name	type	data type	description
ids	required	string	Array of Note ID

Example

 {
     cmd: 'REMOVE_NOTE',
     ids: ['Note Id-1', 'Note Id-2']
 }

Add Comment

cmd: ADD_COMMENT, id: Note Id, text: comment

Body

name	type	data type	description
id	required	string	Note ID
text	required	string	Comment text

Example

  {
      cmd: 'ADD_COMMENT',
      id: 'Note Id-1',
      text: 'My first comment'
  }

Update note color

cmd: REMOVE_NOTE, ids: [Note Id], label: Color label

Body

name	type	data type	description
ids	required	string	Array of Note ID
label	required	string	Color label in format color1, etc ...

Example

  {
      cmd: 'UPDATE_COLOR',
      ids: ['Note Id-1', 'Note Id-2'],
      label: 'color2'
  }

Update note tag

cmd: UPDATE_TAG, ids: [Note Id], tags: [Tags]

Body

name	type	data type	description
ids	required	string	Array of Note ID
tags	required	string	Array of tag name

Example

  {
      cmd: 'UPDATE_TAG',
      ids: ['Note Id-1', 'Note Id-2'],
      tags: ['pain', 'todo']
  }

Add new tag

cmd: ADD_TAG, tag: Tag

Body

name	type	data type	description
ids	required	string	Array of Note ID
tag	required	string	New tag name

Example

  {
      cmd: 'ADD_TAG',
      tag: 'summary'
  }

Add new reaction

cmd: ADD_REACTION, id: Note ID index: Reaction Index

Body

name	type	data type	description
id	required	string	Note ID
index	required	integer	Reaction index (0-4)

Example

  {
      cmd: 'ADD_REACTION',
      id: 'note-id',
      index: 2
  }

Remove reaction

cmd: REMOVE_REACTION, id: Note ID

Body

name	type	data type	description
id	required	string	Note ID

Example

  {
      cmd: 'REMOVE_REACTION',
      id: 'note-id'
  }

Add comment

cmd: ADD_COMMENT, id: Note ID text: Comment text

Body

name	type	data type	description
id	required	string	Note ID
text	required	string	Text content

Example

  {
      cmd: 'ADD_COMMENT',
      id: 'note-id',
      text: 'This idea is brilliant'
  }

Add reply comment

cmd: ADD_COMMENT, id: Note ID text: Comment text parent: Reply Note ID

Body

name	type	data type	description
id	required	string	Note ID
text	required	string	Text content
parent	required	string	Reply Parent Note ID

Example

  {
      cmd: 'ADD_COMMENT',
      id: 'note-id',
      text: 'I like your feedback',
      parent: 'reply to note id'
  }

Remove comment

cmd: REMOVE_COMMENT, id: Note ID commentId: Comment ID

Body

name	type	data type	description
id	required	string	Note ID
commentId	required	string	Comment ID

Example

  {
      cmd: 'REMOVE_COMMENT',
      id: 'note-id',
      commentId: 'Removed comment ID'
  }

Add comment reaction

cmd: ADD_REACTION, id: Note ID commentId: Comment ID index: Reaction Index

Body

name	type	data type	description
id	required	string	Note ID
commentId	required	string	Comment ID
index	required	integer	Reaction index (0-4)

Example

  {
      cmd: 'ADD_REACTION',
      id: 'note-id',
      commentId: 'comment-id',
      index: 2
  }

Remove comment reaction

cmd: REMOVE_REACTION, id: Note ID commentId: Comment ID

Body

name	type	data type	description
id	required	string	Note ID
commentId	required	string	Comment ID

Example

  {
      cmd: 'REMOVE_REACTION',
      id: 'note-id'
      commentId: 'comment-id'
  }