概要
すべてのWebhookイベントは、一貫したペイロード構造に従います。このページでは、すべてのイベントタイプで共通して使用される標準形式を説明します。標準的なイベントの構造
フィールドの説明
トップレベルのフィールド
string
必須
この webhook イベントの一意な識別子です。冪等性と重複排除のために利用します。
string
必須
イベントタイプの識別子です（例:
note.created、note.recording.completed）。string
必須
イベントが発生した時刻を示す ISO-8601 形式の timestamp です。イベントの順序付けに利用します。
string
イベントが属するワークスペースの GUID です。1 つの endpoint が複数のワークスペースのイベントを受け取る場合に、送信元を区別するために利用します。イベントがワークスペースに紐づかない場合は
null です。object
必須
リソース情報を含む、イベント固有のデータです。
data オブジェクトのフィールド
string
必須
イベントを発生させたリソースのタイプです。例:
Note、NoteDocument、NoteSummary、FolderNoteRelation。string
必須
特定のリソースインスタンスの一意な識別子です。素早いルーティングと冪等性のために利用します。
object
必須
実際のリソースデータです。構造はリソースのタイプによって異なり、Tiro の標準スキーマに従います。
イベントタイプ
イベントタイプは、発生した具体的なアクションを示します。いくつかの例を以下に示します。Voice File Jobイベントにはどのようなデータが含まれますか？
voice_file_job.*イベントのdata.resourceには、ジョブのメタデータのみが含まれます。アップロードした音声や文字起こし本文はWebhookに含まれません。