Skip to main content

概要

FolderNoteRelation リソースに関する webhook イベントです。これらのイベントは、フォルダとノートの関係を追跡します。すべての FolderNote イベントは resourceType: "FolderNoteRelation" を使用します。 フォルダイベントもノートイベントと同じ範囲に従います。ワークスペース Webhook では、ワークスペースの全メンバーに共有されたフォルダでの変更のみが配信され、個人フォルダや一部のメンバーにのみ共有したフォルダでの変更は配信されません。組織 Webhook では、組織に属するワークスペースの中で、全メンバーに共有されたフォルダの変更のみを受信します(ワークスペース Webhook と同じ範囲です)。アカウント Webhook では、ユーザーがアクセスできるフォルダであれば、一部のメンバーにのみ共有した(LIMITED)フォルダのイベントも受信します。この範囲が適用される前に登録されたレガシーなシステム endpoint は、当面は従来どおりの動作を維持します。詳しくはシステムAPIキーが読み取るノートの範囲をご覧ください。

イベントの詳細

Resource ID のパターン: folder_{folderId}:note_{noteGuid}

folder.note.added

  • ノートがフォルダに追加されたときにトリガーされます

folder.note.removed

  • ノートがフォルダから削除されたときにトリガーされます

payload の例

folder.note.added

folder.note.removed

リソースデータの構造

FolderNoteRelationExternalEventData

object
必須
フォルダの情報
string
必須
フォルダ ID(文字列形式)
string
必須
フォルダのタイトル
boolean
必須
フォルダの共有設定が PRIVATE 以外の場合に true です(一部のメンバーにのみ共有した LIMITED フォルダも含まれます)。ワークスペース Webhook が実際にイベントを送信するのはワークスペース全体のメンバーに共有されたフォルダのみのため、isTeamFolder だけではイベントが配信される対象かどうかを判断できません。(アカウント Webhook とレガシーなシステム endpoint の例外については上記の概要を参照してください。)
string
必須
追加されたノートの GUID