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

{
  "id": "evt_01J9ABCDEF",
  "type": "note.created",
  "createdAt": "2025-09-05T07:12:34Z",
  "data": {
    "resourceType": "Note",
    "resourceId": "1Lvbn2EQKmQvV",
    "resource": {
      "title": "Meeting Note"
    }
  }
}

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.paragraph.updated).
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, NoteSummary, Paragraph.
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 our standard schemas.

Event Types

Event types identify the specific action that occurred. Here are some examples:
"note.created"
"note.deleted"
"note.metadata.updated"
"note.user_content.updated"
"note.recording.completed"
"note_document.generated"
"note_document.updated"
"note_document.deleted"
"folder.note.added"
"folder.note.removed"
// TODO ...

Resource Type Mapping

Event TypeResource TypeSchema Reference
note.*NoteNote Schema
note_document.*NoteDocumentNoteDocument Events
folder.*FolderNoteRelationFolderNote Events