Skip to main content

Overview

All webhook events use the common structure below.

Standard Event Structure

Field Descriptions

Top-Level Fields

string
required
Unique identifier for this webhook event. Use this for idempotency and deduplication.
string
required
Event type identifier (e.g., note.created, note.recording.completed).
string
required
ISO-8601 timestamp when the event occurred. Use this for event ordering.
string
GUID of the workspace the event belongs to. Use this to tell sources apart when one endpoint receives events from several workspaces. null when the event is not associated with a workspace.
string | null
GUID of the organization the event belongs to. Only populated for organization-level webhooks; null otherwise.
object
required
Event-specific data containing resource information.

Data Object Fields

string
required
The type of resource that triggered the event. Examples: Note, NoteDocument, NoteSummary, FolderNoteRelation.
string
required
Unique identifier for the resource. Use it for routing and deduplication.
object
required
The actual resource data. Structure depends on the resource type and follows Tiro’s standard schemas.

Event Types

Examples of supported event types:

What data does a Voice File Job event include?

The data.resource object for a voice_file_job.* event contains job metadata only. Webhooks do not include uploaded audio or transcript text.

Resource Type Mapping