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

​
概要

すべての webhook イベントは、一貫した payload 構造に従います。このドキュメントでは、すべてのイベントタイプで共通して使用される標準フォーマットについて説明します。

​
標準的なイベントの構造

​
フィールドの説明

​
トップレベルのフィールド

​
id
string
必須
この webhook イベントの一意な識別子です。冪等性と重複排除のために利用します。
​
type
string
必須
イベントタイプの識別子です（例: note.created、note.recording.completed）。
​
createdAt
string
必須
イベントが発生した時刻を示す ISO-8601 形式の timestamp です。イベントの順序付けに利用します。
​
data
object
必須
リソース情報を含む、イベント固有のデータです。

​
data オブジェクトのフィールド

​
data.resourceType
string
必須
イベントを発生させたリソースのタイプです。例: Note、NoteDocument、NoteSummary、FolderNoteRelation。
​
data.resourceId
string
必須
特定のリソースインスタンスの一意な識別子です。素早いルーティングと冪等性のために利用します。
​
data.resource
object
必須
実際のリソースデータです。構造はリソースのタイプによって異なり、Tiro の標準スキーマに従います。

​
イベントタイプ

イベントタイプは、発生した具体的なアクションを示します。いくつかの例を以下に示します。 
"note.created"
"note.deleted"
"note.user_content.updated"
"note.recording.completed"
"note.ended"
"note.participants.updated"
"note_document.generated"
"note_document.updated"
"note_document.deleted"
"note_summary.generated"
"note_summary.updated"
"note_summary.deleted"
"folder.note.added"
"folder.note.removed"

​
リソースタイプの対応表

Event TypeResource TypeSchema Reference
note.*NoteNote API
note_document.*NoteDocumentNoteDocument Events
note_summary.*NoteSummaryNoteSummary Events
folder.*FolderNoteRelationFolderNote Events