How to get the list of Engagements

You can use the following to fetch the list of engagements 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 ID	Event Data Key	Description
`crm_engagement_info`	`info`
`crm_engagement_type`	`type`
`crm_engagement_accounts`	`accounts`	Get the Account IDs that are associated with the engagement
`crm_engagement_contacts`	`contacts`	Get the Contact IDs that are associated with the engagement
`crm_engagement_leads`	`leads`	Get the Lead IDs that are associated with the engagement
`crm_engagement_deals`	`deals`	Get the Deal IDs that are associated with the engagement
`crm_engagement_custom_fields`	`customFields`
`User Mapped Fields`	`userMappedFields`	Field Mappings done via Mapping Presets

Engagement Info

Model ID: crm_engagement_info

Name	Type	Description
`id`	`String`
`content`	`String`
`subject`	`String`
`direction`	`Enum`	One of `INBOUND`, `OUTBOUND`, `NOT_SPECIFIED`
`owner`	`User`	Please refer to https://developers.getknit.dev/reference/base-models#user
`startDateTime`	`Date`
`endDateTime`	`Date`
`status`	`Enum`	One of `NOT_STARTED`, `IN_PROGRESS`, `COMPLETED`, `CANCELLED`, `FAILED`, `WAITING_ON_SOMEONE`
`url`	`String`	The URL related to the engagement. Example: call recording, meeting transcript etc.

Engagement Type

Model ID: crm_engagement_type

Name	Type	Description
`id`	`String`
`type`	`Enum`	One of `CALL`, `MEETING`, `EMAIL`, `COMMUNICATION` `NOT_SPECIFIED`
`name`	`String`

Engagement Accounts

Model ID: crm_engagement_accounts

Name	Type	Description
`accounts`	`List[String]`	Account IDs associated with the engagement

Engagement Contacts

Model ID: crm_engagement_contacts

Name	Type	Description
`contacts`	`List[String]`	Contact IDs associated with the engagement

Engagement Leads

Model ID: crm_engagement_leads

Name	Type	Description
`leads`	`List[String]`	Lead IDs associated with the engagement

Engagement Deals

Model ID: crm_engagement_deals

Name	Type	Description
`deals`	`List[String]`	Deal IDs associated with the engagement

Custom Fields

Model ID: crm_engagement_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": "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": "matson@gojo.com"
    },
    "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"
  ],
  "deals": [
    "768274"
  ]
}