Engagement Data Models

Model IDEvent Data KeyDescription
crm_engagement_infoinfo
crm_engagement_typetype
crm_engagement_accountsaccountsGet the Account IDs that are associated with the engagement
crm_engagement_contactscontactsGet the Contact IDs that are associated with the engagement
crm_engagement_leadsleadsGet the Lead IDs that are associated with the engagement
crm_engagement_custom_fieldscustomFields
User Mapped FieldsuserMappedFieldsField Mappings done via Mapping Presets

Engagement Info

Model ID: crm_engagement_info

NameTypeDescription
idString
contentString
subjectString
directionEnumOne of
INBOUND,
OUTBOUND,
NOT_SPECIFIED
ownerUserPlease refer to https://developers.getknit.dev/reference/base-models#user
startDateTimeDate
endDateTimeDate
statusEnumOne of
NOT_STARTED,
IN_PROGRESS,
COMPLETED,
CANCELLED,
FAILED,
WAITING_ON_SOMEONE
urlStringThe URL related to the engagement. Example: call recording, meeting transcript etc.

Engagement Type

Model ID: crm_engagement_type

NameTypeDescription
idString
typeEnumOne of
CALL,
MEETING,
EMAIL,
COMMUNICATION
NOT_SPECIFIED
nameString

Engagement Accounts

Model ID: crm_engagement_accounts

NameTypeDescription
accountsList[String]Account IDs associated with the engagement

Engagement Contacts

Model ID: crm_engagement_contacts

NameTypeDescription
contactsList[String]Contact IDs associated with the engagement

Engagement Leads

Model ID: crm_engagement_leads

NameTypeDescription
leadsList[String]Lead IDs associated with the engagement

Custom Fields

Model ID: crm_engagement_custom_fields

All the custom/auto populated/calculated fields in the source CRM.

NameTypeDescription
fieldsMap<String, Object>

❗️

If you're only interested in a subset of fields rather than all the fields, consider mapping the fields you want using Mapping Presets. Custom Fields often include large number of CRM calculated and auto updated fields which might lead to a huge volume in delta_syncs

User Mapped Fields

Edit Field Mappings from the Knit dashboard for each integrated account to get unmapped fields. Read more about it here: https://developers.getknit.dev/docs/get-custom-fields-sync

NameTypeDescription
fieldsMap<String, Object>

Event Data Example

{
  "info": {
    "id": "35114635700",
    "content": "<div style=\"\" dir=\"auto\" data-top-level=\"true\"><p style=\"margin:0;\">Can we discuss the upcoming deal terms?</p></div>",
    "subject": "Can we discuss the upcoming deal terms?",
    "direction": "INBOUND",
    "owner": {
      "id": "407425865",
      "email": "[email protected]"
    },
    "startDateTime": "2023-05-23T12:04:28Z",
    "endDateTime": "2023-05-23T12:04:28Z",
    "status": "NOT_SPECIFIED",
    "url": "https//hubspot.com/recording/35114635700"
  },
  "type": {
    "id": null,
    "type": "COMMUNICATION",
    "name": "Call"
  },
  "accounts": [
    "15828038229"
  ],
  "contacts": [
    "101"
  ],
  "leads": [
    "13422012089"
  ]
}