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.

Record webhooks fire when a CRM record is created, updated, or deleted. Create and update payloads include the current record snapshot and fields keyed by field slug. All record webhooks use the same webhook envelope documented in Webhooks. The data object changes by event type.

​
Events

EventCategoryWhen it fires
record.createdCRMFired when a new record is created.
record.updatedCRMFired when a record field is updated.
record.deletedCRMFired when a record is deleted.

​
Payload examples

​
record.created

Fired when a new record is created. 
{
  "eventId": "evt_abc123",
  "timestamp": "2026-03-19T12:00:00.000Z",
  "workspaceId": "workspace_id",
  "event": "record.created",
  "data": {
    "id": "record_id",
    "objectType": "person",
    "objectTypeName": "Person",
    "name": "Ada Lovelace",
    "fields": {
      "name": "Ada Lovelace",
      "email": "ada@example.com",
      "company": "Analytical Engines Ltd"
    },
    "createdAt": "2026-03-19T12:00:00.000Z",
    "updatedAt": "2026-03-19T12:00:00.000Z"
  }
}

​
record.updated

Fired when a record field is updated. 
{
  "eventId": "evt_abc123",
  "timestamp": "2026-03-19T12:00:00.000Z",
  "workspaceId": "workspace_id",
  "event": "record.updated",
  "data": {
    "id": "record_id",
    "objectType": "person",
    "objectTypeName": "Person",
    "name": "Ada Lovelace",
    "fields": {
      "name": "Ada Lovelace",
      "email": "ada@newdomain.example"
    },
    "createdAt": "2026-03-19T12:00:00.000Z",
    "updatedAt": "2026-03-19T12:10:00.000Z"
  }
}

​
record.deleted

Fired when a record is deleted. 
{
  "eventId": "evt_abc123",
  "timestamp": "2026-03-19T12:00:00.000Z",
  "workspaceId": "workspace_id",
  "event": "record.deleted",
  "data": {
    "id": "record_id",
    "deleted": true
  }
}