Skip to main content

​
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

​
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.
​
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 specific resource instance. Use this for quick routing and idempotency.
​
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:

​
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