Skip to main content

Documentation Index

Fetch the complete documentation index at: https://api-docs.tiro.ooo/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

All webhook events follow a consistent payload structure. This document describes the standard format used across all event types.

​
Standard Event Structure

​
Field Descriptions

​
Top-Level Fields

​
id
string
required
Unique identifier for this webhook event. Use this for idempotency and deduplication.
​
type
string
required
Event type identifier (e.g., note.created, note.recording.completed).
​
createdAt
string
required
ISO-8601 timestamp when the event occurred. Use this for event ordering.
​
data
object
required
Event-specific data containing resource information.

​
Data Object Fields

​
data.resourceType
string
required
The type of resource that triggered the event. Examples: Note, NoteDocument, NoteSummary, FolderNoteRelation.
​
data.resourceId
string
required
Unique identifier for the specific resource instance. Use this for quick routing and idempotency.
​
data.resource
object
required
The actual resource data. Structure depends on the resource type and follows Tiro’s standard schemas.

​
Event Types

Event types identify the specific action that occurred. Here are some examples: 
"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"

​
Resource Type Mapping

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