API Reference
Doc HomeSupport

Notification Payload Specification

🚧

Preview

The notifications specification is currently available as a preview, and is subject to change. Contact your Tamr account manager for information.

Notification are published as POST /<webhook-url> requests.

Individual notifications are published for CREATE, UPDATE, and DELETE golden record events.

For golden record merges, an UPDATE event is published to update the data in the surviving golden record. A DELETE event is sent for the retired golden record. These two physical events are grouped together as one logical event by the same versionId value. They are ordered by two different values for recordNumber.

For golden record unmerges, two UPDATE events are published: one for the surviving record and one for the previously retired (resurrected) record. These two physical events are grouped together as one logical event by the same versionId value. They are ordered by two different values for recordNumber.

Notification Payload

Notification payloads contain the following attributes:

AttributeData TypeDescription
idStringUnique id for the realtime authoring event.
timeTimestampThe time the event occurred.
typeStringThe event authoring type.
specVersionStringThe specification version of the event type.
dataContentTypeStringThe HTTP content type. Always set to application/json.
dataStructEvent type-specific contents of the notification.
data > tableIDStringA unique ID for the Tamr table containing the record.
data > recordIDStringA unique ID for the Tamr record.
data > versionIdIntA unique ID for the logical action.
data > changeTypeStringThe enumerated event action type: CREATE, UPDATE, DELETE.
data > newDataStructThe new record data resulting from the authoring event. Blank for DELETE events.
data > recordNumberIntZero-based ordinal uniquely identifying the record within logically the same action.

Example Payloads

CREATE Record Event Payload

{  
  "id": "3d8f82da-bf51-4d52-944a-11feb4ab333e",  
  "source": "<subdomain>.tamr.cloud/webhooks/webhook_220394",  
  "time": "2024-11-18T10:27:14.011Z",  
  "type": "com.tamr.cloud/DataChangeEvent",  
  "specVersion": "1.0",  
  "dataContentType": "application/json",  
  "data": {  
    "tableId": "tbl_1234",  
    "recordId": "rec_5678",  
    "versionId": 235523,  
    "changeType": "CREATE",  
    "newData": {  
      "dob": "2023/04/23"  
    },  
    "recordNumber": 0  
  }  
}

UPDATE Record Event Payload

{
  "id": "3d8f82da-bf51-4d52-944a-11feb4ab333e",
  "source": "<subdomain>.tamr.cloud/webhooks/webhook_220394",
  "time": "2024-11-18T10:27:14.011Z",
  "type": "com.tamr.cloud/DataChangeEvent",
  "specVersion": "1.0",
  "dataContentType": "application/json",
  "data": {
    "tableId": "tbl_1234",
    "recordId": "rec_5678",
    "versionId": 235523,
    "changeType": "UPDATE",
    "newData": {
      "dob": "2023/04/23"
    },
    "recordNumber": 0
  }
}

DELETE Record Event Payload

{
  "id": "3d8f82da-bf51-4d52-944a-11feb4ab333e",
  "source": "<subdomain>.tamr.cloud/webhooks/webhook_220394",
  "time": "2024-11-18T10:27:14.011Z",
  "type": "com.tamr.cloud/DataChangeEvent",
  "specVersion": "1.0",
  "dataContentType": "application/json",
  "data": {
    "tableId": "tbl_1234",
    "recordId": "rec_5678",
    "versionId": 235523,
    "changeType": "DELETE",
    "newData": {},
    "recordNumber": 0
  }
}

MERGE Record Event Payload

UPDATE payload for surviving record:

{
  "id": "4c0ca5a7-0b59-4e35-956c-18c6ea2e3443",
  "source": "<subdomain>.tamr.cloud/webhooks/webhook_220394",
  "time": "2025-01-20T20:14:39.758Z",
  "type": "tamr.api.v1beta1.DataChangeEvent",
  "specVersion": "1.0",
  "dataContentType": "application/json",
  "data": {
    "changeType": "UPDATE",
    "recordNumber": 1.0,
    "tableId": "tbl_1234",
    "versionId": "2568",
    "newData": {
      "dob": "2023/04/23"
    },
    "recordId": "rec_ePv"
  }
}

DELETE payload for retired record:

{
  "id": "141e1e6d-1321-482f-ae28-2084c3058998",
  "source": "<subdomain>.tamr.cloud/webhooks/webhook_220394",
  "time": "2025-01-20T20:14:39.758Z",
  "type": "tamr.api.v1beta1.DataChangeEvent",
  "specVersion": "1.0",
  "dataContentType": "application/json",
  "data": {
    "changeType": "DELETE",
    "recordNumber": 0.0,
    "tableId": "tbl_1234",
    "versionId": "2568",
    "newData": {},
    "recordId": "rec_EAD"
  }
}

UNMERGE Record Event Payload

UPDATE payload for surviving record:

{
  "id": "ae2e6be3-1651-4973-809a-69991455b9f3",
  "source": "<subdomain>.tamr.cloud/webhooks/webhook_220394",
  "time": "2025-01-20T20:57:32.298Z",
  "type": "tamr.api.v1beta1.DataChangeEvent",
  "specVersion": "1.0",
  "dataContentType": "application/json",
  "data": {
    "changeType": "UPDATE",
    "recordNumber": 1.0,
    "tableId": "tbl_1234",
    "versionId": "2569",
    "newData": {
      "dob": "2023/04/23"
    },
    "recordId": "rec_EAD"
  }
}

UPDATE payload for resurrected record:

{
  "id": "10b4cf49-6203-474c-a05a-40ff59b34815",
  "source": "<subdomain>.tamr.cloud/webhooks/webhook_220394",
  "time": "2025-01-20T20:57:32.298Z",
  "type": "tamr.api.v1beta1.DataChangeEvent",
  "specVersion": "1.0",
  "dataContentType": "application/json",
  "data": {
    "changeType": "UPDATE",
    "recordNumber": 0.0,
    "tableId": "tbl_1234",
    "versionId": "2569",
    "newData": {
      "dob": "2023/04/23"
    },
    "recordId": "rec_ePv"
  }
}