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.

Relation webhooks fire when a relationship between two records is added or removed. All relation webhooks use the same webhook envelope documented in Webhooks. The data object changes by event type.

​
Events

EventCategoryWhen it fires
relation.addedCRMFired when a relation is added between records.
relation.removedCRMFired when a relation is removed between records.

​
Payload examples

​
relation.added

Fired when a relation is added between records. 
{
  "eventId": "evt_abc123",
  "timestamp": "2026-03-19T12:00:00.000Z",
  "workspaceId": "workspace_id",
  "event": "relation.added",
  "data": {
    "sourceRecordId": "record_id",
    "targetRecordId": "related_record_id",
    "fieldDefinitionId": "field_definition_id",
    "fieldSlug": "company"
  }
}

​
relation.removed

Fired when a relation is removed between records. 
{
  "eventId": "evt_abc123",
  "timestamp": "2026-03-19T12:00:00.000Z",
  "workspaceId": "workspace_id",
  "event": "relation.removed",
  "data": {
    "sourceRecordId": "record_id",
    "targetRecordId": "related_record_id",
    "fieldDefinitionId": "field_definition_id",
    "fieldSlug": "company"
  }
}