Custom Objects Records Data Model

How to get the list of Custom Objects Records

You can use the following to fetch the list of custom objects records from your integrations:

Syncs (Webhook-based Bulk Reads)

Syncs provide an automated, push-based approach for bulk data retrieval. Once you set up a sync for an integration, Knit polls the source app for changes and sends updates straight to your webhook. This webhook-based model eliminates the need for you to continuously pull data.

Read more about syncs and webhooks here: https://developers.getknit.dev/docs/register-webhook-url#/

Data Model

Model IDEvent Data KeyDescription
crm_record_infoinfo
crm_record_fieldsfields

Record Info

Model ID: crm_record_info

NameTypeDescription
idString
schemaIdString
nameString
externalIdString
createdAtDate
updatedAtDate
lastActivityAtDate
createdByString
updatedByString

Record Fields

Model ID: crm_record_fields

NameTypeDescription
fieldsMap<String, Object>

Event Data Example

{
  "info": {
    "id": "",
    "name": "",
    "externalId": "",
    "createdAt": "",
    "createdBy": "",
    "updatedAt": "",
    "updatedBy": "",
    "schemaId": ""
  },
  "fields": {
    "field1": "value1",
    "field2": "value2"
  }
}