メインコンテンツへスキップ

概要

Note リソースに関する webhook イベントです。すべての note イベントは resourceType: "Note" を使用します。

イベントの詳細

note.created

  • ライブ音声ノートの録音を開始したとき
  • 録音ファイルからノートを作成したとき

note.deleted

  • ユーザーがノートを完全に削除したとき

note.recording.completed(録音の一時停止)

  • ライブ録音を一時停止し、その時点までの音声処理、テキスト変換、段落の生成が完了したときに発生します
  • 1 回の会議で録音を複数回一時停止できるため、同じノートで複数回発生することがあります
  • 互換性のためイベント名に completed が残っていますが、ノートの終了を意味しません。最終的な終了は note.ended で確認してください

note.user_content.updated

  • ユーザーがノートの内容を手動で編集したとき

note.ended

  • ノートが完全に終了したとき(すべての処理が完了した後)にトリガーされます
  • 複数回発生することがある note.recording.completed とは異なり、ノートのライフサイクルごとに 1 回だけ発生します
  • これはノートの完了を示す、確定的なイベントです
  • ノートが最終状態に達したことを把握する必要がある場合に、このイベントを利用してください

note.participants.updated

  • ノートに会議の参加者が追加または削除されたときにトリガーされます
  • 既存の参加者の名前やメールアドレスが更新された場合には発生しません
  • resource フィールドには、更新後の participants 配列を含む完全な Note オブジェクトが含まれます

payload の例

リソースデータ

Note イベントには、完全な Note リソースデータが含まれます。各フィールドの説明については、Note API をご覧ください。 重要: Note リソースには metadata のみが含まれます。transcript の内容を取得するには、List Note Paragraphs API を使用して、実際のテキストデータを取得してください。

ガイド

録音の一時停止とノートの終了を区別する

  • note.recording.completed は録音の一時停止を示します。受信するたびに最新のノートデータを取得してください
  • note.ended はノートが完全に終了した後に 1 回だけ発生します
  • 両方のイベントを購読すると、一時停止時点の途中結果と最終結果を分けて処理できます
シナリオの例:
  1. 会議を開始 → 録音を開始
  2. 録音を一時停止 → transcript と要約を処理 → note.recording.completed が発生
  3. 録音を再開 → 処理を継続
  4. 録音を一時停止 → note.recording.completed が再度発生
  5. 録音を再開して終了 → note.ended が発生
処理の例: