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.

File webhooks fire when a file is uploaded to or deleted from a record. All file webhooks use the same webhook envelope documented in Webhooks. The data object changes by event type.

​
Events

EventCategoryWhen it fires
file.uploadedFilesFired when a file is uploaded to a record.
file.deletedFilesFired when a file is deleted from a record.

​
Payload examples

​
file.uploaded

Fired when a file is uploaded to a record. 
{
  "eventId": "evt_abc123",
  "timestamp": "2026-03-19T12:00:00.000Z",
  "workspaceId": "workspace_id",
  "event": "file.uploaded",
  "data": {
    "recordId": "record_id",
    "fileName": "contract.pdf"
  }
}

​
file.deleted

Fired when a file is deleted from a record. 
{
  "eventId": "evt_abc123",
  "timestamp": "2026-03-19T12:00:00.000Z",
  "workspaceId": "workspace_id",
  "event": "file.deleted",
  "data": {
    "recordId": "record_id",
    "fileName": "contract.pdf"
  }
}