Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.breakcold.com/llms.txt

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

Note webhooks fire when a note attached to a record is created, edited, or deleted. All note webhooks use the same webhook envelope documented in Webhooks. The data object changes by event type.

​
Events

EventCategoryWhen it fires
note.createdNotesFired when a note is added to a record.
note.updatedNotesFired when a note is edited.
note.deletedNotesFired when a note is deleted.

​
Payload examples

​
note.created

Fired when a note is added to a record. 
{
  "eventId": "evt_abc123",
  "timestamp": "2026-03-19T12:00:00.000Z",
  "workspaceId": "workspace_id",
  "event": "note.created",
  "data": {
    "recordId": "record_id",
    "noteId": "note_id",
    "title": "Follow up",
    "contentPlain": "Discussed pricing and next steps.",
    "author": "Jane Smith",
    "createdAt": "2026-03-19T12:00:00.000Z",
    "updatedAt": "2026-03-19T12:00:00.000Z"
  }
}

​
note.updated

Fired when a note is edited. 
{
  "eventId": "evt_abc123",
  "timestamp": "2026-03-19T12:00:00.000Z",
  "workspaceId": "workspace_id",
  "event": "note.updated",
  "data": {
    "recordId": "record_id",
    "noteId": "note_id",
    "title": "Follow up",
    "contentPlain": "Send the pricing deck before Friday.",
    "author": "Jane Smith",
    "createdAt": "2026-03-19T12:00:00.000Z",
    "updatedAt": "2026-03-19T12:15:00.000Z"
  }
}

​
note.deleted

Fired when a note is deleted. 
{
  "eventId": "evt_abc123",
  "timestamp": "2026-03-19T12:00:00.000Z",
  "workspaceId": "workspace_id",
  "event": "note.deleted",
  "data": {
    "recordId": "record_id",
    "noteId": "note_id",
    "title": "Follow up"
  }
}