Represents a sales opportunity or a deal
Model ID | Event Data Key | Description |
---|---|---|
crm_deal_info | info | |
crm_deal_stage | stage | |
crm_deal_accounts | accounts | Get the Account IDs that are associated with the deal |
crm_deal_contacts | contacts | Get the Contact IDs that are associated with the deal |
crm_deal_custom_fields | customFields | |
User Mapped Fields | userMappedFields | Field Mappings done via Mapping Presets |
Deal Info
Model ID: crm_deal_info
Name | Type | Description |
---|---|---|
id | String | |
name | String | |
description | String | |
amount | Double | |
currency | String | |
owner | User | Please refer to https://developers.getknit.dev/reference/base-models#user |
createdBy | User | Please refer to https://developers.getknit.dev/reference/base-models#user |
status | Enum | One ofOPEN ,WON ,LOST |
createdAt | Date | |
lastActivityAt | Date |
Deal Stage
Model ID: crm_deal_stage
Name | Type | Description |
---|---|---|
stageId | String | |
stageName | String | |
pipelineId | String | If the CRM system supports multiple pipelines, the ID of the pipeline to which the stage belongs |
pipelineName | String | If the CRM system supports multiple pipelines, the name of the pipeline to which the stage belongs |
Deal Accounts
Model ID: crm_deal_accounts
Name | Type | Description |
---|---|---|
accounts | List[String] | Account IDs associated with the deal |
Deal Contacts
Model ID: crm_deal_contacts
Name | Type | Description |
---|---|---|
contacts | List[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.
Name | Type | Description |
---|---|---|
fields | Map<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
Name | Type | Description |
---|---|---|
fields | Map<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"
]
}