HubSpot API Data Model
MarketingEventsByExternalEventId |
Get Marketing Event by External IDsReturns the details of a Marketing Event with the specified externalAccountId, externalEventId, if it exists.Only Marketing Events created by the same app making the request can be retrieved.
Catalog: MarketingEvents3
Schema: Basic
Label: {res:itgen_hubspot_marketingeventsbyexternaleventid_plural}
This is a read-only table function. The HubSpot API may not support changing the data or the Invantive UniversalSQL driver for HubSpot does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the HubSpot API.
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function MarketingEventsByExternalEventId. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
|---|---|---|---|---|
externalAccountId |
string |
☑ |
|
The accountId that is associated with this marketing event in the external event application |
externalEventId |
string |
☑ |
|
The id of the marketing event in the external event application |
Columns of Table Function
The columns of the table function MarketingEventsByExternalEventId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
attendees |
int32 |
Attendees |
☐ |
The number of HubSpot contacts that attended this marketing event. |
cancellations |
int32 |
Cancellations |
☐ |
The number of HubSpot contacts that registered for this marketing event, but later cancelled their registration. |
createdAt |
datetime |
Created at |
☐ |
|
endDateTime |
datetime |
End Date Time |
☐ |
The end date and time of the marketing event. |
eventCancelled |
boolean |
Event Cancelled |
☐ |
Indicates if the marketing event has been cancelled. |
eventCompleted |
boolean |
{res:itgen_hubspot_eventcompleted} |
☐ |
|
eventDescription |
string |
Event Description |
☐ |
The description of the marketing event. |
eventName |
string |
Event Name |
☐ |
The name of the marketing event. |
eventOrganizer |
string |
Event Organizer |
☐ |
The name of the organizer of the marketing event. |
eventType |
string |
Event Type |
☐ |
The type of the marketing event. |
eventUrl |
string |
Event (URL) |
☐ |
A URL in the external event application where the marketing event can be managed. |
externalEventId |
string |
External Event ID |
☐ |
The id of the marketing event in the external event application. |
id |
string |
ID |
☐ |
|
noShows |
int32 |
No Shows |
☐ |
The number of HubSpot contacts that registered for this marketing event, but did not attend. This field only had a value when the event is over. |
objectId |
string |
Object ID |
☐ |
|
registrants |
int32 |
Registrants |
☐ |
The number of HubSpot contacts that registered for this marketing event. |
startDateTime |
datetime |
Start Date Time |
☐ |
The start date and time of the marketing event. |
updatedAt |
datetime |
Updated at |
☐ |
|
18-12-2024 20:09 Version 24.1.33-BETA+5180
