Skip to main content

​
Overview

Webhook events for FolderNoteRelation resources. These events track the relationship between folders and notes. All FolderNote events use resourceType: "FolderNoteRelation". Folder events follow the same read scope as note events. For a workspace webhook, only changes in folders shared with all workspace members are delivered; changes in a private folder, or in a folder shared with only some members, are not. An organization webhook only receives changes in folders shared with all members of a workspace, across the organization’s workspaces (the same scope as a workspace webhook). An account webhook also receives events for folders shared with only some members (LIMITED), as long as the user can access them. Legacy system endpoints registered before this scope policy took effect keep their previous, broader behavior for now. See What notes a system API key reads for details.

​
Event Details

Resource ID pattern: folder_{folderId}:note_{noteGuid}

​
folder.note.added

  • Triggered when a note is added to a folder

​
folder.note.removed

  • Triggered when a note is removed from a folder

​
Example Payloads

​
folder.note.added

​
folder.note.removed

​
Resource Data Structure

​
FolderNoteRelationExternalEventData

​
object
required
Folder information
​
string
required
Folder ID (as string)
​
string
required
Folder title
​
boolean
required
True when the folder’s sharing setting is anything other than PRIVATE (this includes LIMITED folders shared with only some members). Note that a workspace webhook only actually sends events for folders shared with all workspace members, so isTeamFolder alone doesn’t tell you whether events will be delivered for a given folder. (See the overview above for the account webhook and legacy system endpoint exceptions.)
​
string
required
GUID of the added note