CData Python Connector for HubSpot

Build 25.0.9454

Engagements

Represents various types of interactions in HubSpot, including calls, emails, and tasks, useful for tracking customer engagement activities.

Table Specific Information

Engagements represent any of a number of different types of engagements you have in HubSpot. These can very from simple Tasks, to Emails, Calls, Meetings, or others. Due to the different types of engagements available, any individual Engagement will have several columns that come back null due to its type.

SELECT

When selecting engagements, they can only be filtered by the Id. For instance: 

SELECT * FROM Engagements WHERE Id = 12345

Insert and Update

When inserting Engagements, a Type must be specified. In addition, different fields are available on insert depending on the type used. The available fields for each type are as follows: CALL, EMAIL, MEETING, NOTE, PUBLISHING_TASK, TASK

  • CALL: ToNumber, FromNumber, Body, DurationMilliseconds, Status, ExternalId, ExternalAccountId, RecordingUrl, Disposition
  • EMAIL: FromEmail, FromFirstName, FromLastName, ToEmail, Cc, Bcc, Subject, EmailHtml, EmailText
  • MEETING: Body, StartTime, EndTime, Title
  • PUBLISHING_TASK: Body, CampaignGuid, Category, CategoryId, State, Name
  • TASK: Body, Status, ForObjectType
In addition, there are some common fields available when inserting or updating any type of Engagement. These include DateTime, AssociatedContacts, AssociatedCompanies, AssociatedDeals, AssociatedOwners, and AssociatedWorkflows. For instance: 
INSERT INTO Engagements (DateTime, Type, Body, CampaignGuid, Category, CategoryId, ContentId, State, Name, AssociatedContacts) VALUES ('1/1/2011', 'PUBLISHING_TASK', 'Cool Post with Topics', 'f43fe9fd-4082-4a45-93d8-cb8a88f01654', 'BLOG_POST', 3, '2682673052', 'TODO', 'Test Blog Task With topics 3', '234, 567')

Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Unique identifier assigned to the engagement.

PortalId Long True

HubSpot portal ID associated with the engagement.

IsActive Boolean True

Boolean flag indicating whether the engagement is active.

CreatedAt Datetime True

Timestamp indicating when the engagement was created.

UpdatedAt Datetime True

Timestamp indicating when the engagement was last updated.

CreatedBy Long True

User ID of the user who originally created the engagement.

ModifiedBy Long True

User ID of the user who last modified the engagement.

OwnerId Long False

Owner ID assigned to the engagement.

Type String False

Type of engagement, such as NOTE, TASK, CALL, MEETING, or EMAIL. Required for inserts.

ActivityType String False

Activity type associated with the engagement, providing additional classification.

DateTime Datetime False

Custom datetime field for specifying when the engagement-related action occurred, such as the time of a call.

AssociatedContacts String False

Comma-separated list of contact IDs associated with the engagement.

AssociatedCompanies String False

Comma-separated list of company IDs associated with the engagement.

AssociatedDeals String False

Comma-separated list of deal IDs associated with the engagement.

AssociatedOwners String True

Comma-separated list of owner IDs associated with the engagement.

AssociatedWorkflows String False

Comma-separated list of workflow IDs associated with the engagement.

AssociatedTickets String False

Comma-separated list of ticket IDs associated with the engagement.

Attachments String False

Comma-separated list of attachments associated with this engagement.

MessageId String False

Message ID related to the engagement, if applicable.

ThreadId String False

Thread ID related to the engagement, if applicable.

Body String False

Body content of the engagement. Used when Type is NOTE, TASK, PUBLISHING_TASK, CALL, or MEETING.

Status String False

Status of the engagement task. Applicable for TASK, CALL, or MEETING types.

ForObjectType String False

The object type the task is related to, such as CONTACT. Applicable for TASK type.

StartTime String False

Start datetime of the meeting. Applicable when Type is MEETING.

EndTime String False

End datetime of the meeting. Applicable when Type is MEETING.

Title String False

Title of the meeting. Applicable when Type is MEETING.

FromEmail String False

Sender email address in the engagement. Applicable when Type is EMAIL.

FromFirstName String False

First name of the sender. Applicable when Type is EMAIL.

FromLastName String False

Last name of the sender. Applicable when Type is EMAIL.

ToEmail String False

Comma-separated list of recipient email addresses. Applicable when Type is EMAIL.

Cc String False

Comma-separated list of CC email addresses. Applicable when Type is EMAIL.

Bcc String False

Comma-separated list of BCC email addresses. Applicable when Type is EMAIL.

Subject String False

Subject line of the email engagement. Applicable when Type is EMAIL.

EmailHtml String False

HTML content of the email body. Applicable when Type is EMAIL.

EmailText String False

Plain text content of the email body. Applicable when Type is EMAIL.

CampaignGuid String False

Campaign GUID associated with the engagement. Applicable when Type is PUBLISHING_TASK.

Category String False

Category classification of the engagement. Applicable when Type is PUBLISHING_TASK.

CategoryId Integer False

Category ID of the engagement. Applicable when Type is PUBLISHING_TASK.

ContentId String False

Content ID associated with the engagement. Applicable when Type is PUBLISHING_TASK.

State String False

State or status of the engagement. Applicable when Type is PUBLISHING_TASK.

Name String False

Name of the engagement. Applicable when Type is PUBLISHING_TASK.

ToNumber String False

Phone number dialed in the engagement. Applicable when Type is CALL.

FromNumber String False

Phone number used as the sender's number in the engagement. Applicable when Type is CALL.

ExternalId String False

Internal ID of the call in HubSpot. Applicable when Type is CALL.

DurationMilliseconds Long False

Duration of the call in milliseconds. Applicable when Type is CALL.

ExternalAccountId String False

Internal ID of the account used to make the call. Applicable when Type is CALL.

RecordingUrl String False

URL to the recording file of the call. Applicable when Type is CALL.

Disposition String False

Internal GUID corresponding to the call outcome. Applicable when Type is CALL.

MeetingOutcome String False

Meeting outcome classification. Applicable when Type is MEETING. Allowed values include SCHEDULED, COMPLETED, RESCHEDULED, NO SHOW, CANCELED.

TaskType String False

Task type classification. Applicable when Type is TASK. Allowed values: TODO, EMAIL, CALL.

ExtraUrlParameters String True

Optional input-only property for specifying additional query parameters when retrieving engagement data. Format: 'param1=value1, param2=value2, param3=value3'.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454