Deal Data Models

Represents a sales opportunity or a deal

Model IDEvent Data KeyDescription
crm_deal_infoinfo
crm_deal_stagestage
crm_deal_accountsaccountsGet the Account IDs that are associated with the deal
crm_deal_contactscontactsGet the Contact IDs that are associated with the deal
crm_deal_custom_fieldscustomFields
User Mapped FieldsuserMappedFieldsField Mappings done via Mapping Presets

Deal Info

Model ID: crm_deal_info

NameTypeDescription
idString
nameString
descriptionString
amountDouble
currencyString
ownerUserPlease refer to https://developers.getknit.dev/reference/base-models#user
createdByUserPlease refer to https://developers.getknit.dev/reference/base-models#user
statusEnumOne of
OPEN,
WON,
LOST
createdAtDate
lastActivityAtDate

Deal Stage

Model ID: crm_deal_stage

NameTypeDescription
stageIdString
stageNameString
pipelineIdStringIf the CRM system supports multiple pipelines, the ID of the pipeline to which the stage belongs
pipelineNameStringIf the CRM system supports multiple pipelines, the name of the pipeline to which the stage belongs

Deal Accounts

Model ID: crm_deal_accounts

NameTypeDescription
accountsList[String]Account IDs associated with the deal

Deal Contacts

Model ID: crm_deal_contacts

NameTypeDescription
contactsList[String]Contact IDs associated with the deal

Custom Fields

Model ID: crm_deal_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": "13415674244",
      "name": "Waystar Royco",
      "description": "Entertainment Company looking for our product",
      "amount": 100000.0,
      "currency": "USD",
      "owner": {
        "id": "407425865",
        "email": "[email protected]"
      },
      "createdBy": {
        "id": "51501658",
        "email": "[email protected]"
      },
      "status": "WON",
      "createdAt": "2023-05-22T20:04:24Z",
      "lastActivityAt": "2023-05-22T20:04:24Z"
    },
    "stage": {
      "stageId": "closedwon",
      "stageName": "Closed Won",
      "pipelineId": "default",
      "pipelineName": "Sales Pipeline"
    },
    "accounts": [
      "15741522528"
    ],
    "contacts": [
      "51"
    ]
  }