HubSpot API Data Model
IntegratorTimelineEventTemplateTokenOptionsByAppId |
List all event templates for your appUse this to list all event templates owned by your app.
Catalog: Timeline3
Schema: Templates
Label: {res:itgen_hubspot_integratortimelineeventtemplatetokenoptionsbyappid_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 IntegratorTimelineEventTemplateTokenOptionsByAppId. 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 |
|---|---|---|---|---|
appId |
int32 |
☑ |
|
The ID of the target app. |
Columns of Table Function
The columns of the table function IntegratorTimelineEventTemplateTokenOptionsByAppId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
createdAt_2 |
datetime |
{res:itgen_hubspot_createdat_2} |
☐ |
The date and time that the Event Template was created, as an ISO 8601 timestamp. Will be null if the template was created before Feb 18th, 2020. |
createdAt |
datetime |
Created at |
☐ |
The date and time that the Event Template Token was created, as an ISO 8601 timestamp. Will be null if the template was created before Feb 18th, 2020. |
detailTemplate |
string |
Detail Template |
☐ |
This uses Markdown syntax with Handlebars and event-specific data to render HTML on a timeline when you expand the details. |
headerTemplate |
string |
Header Template |
☐ |
This uses Markdown syntax with Handlebars and event-specific data to render HTML on a timeline as a header. |
id |
string |
ID |
☐ |
The template ID. |
label_2 |
string |
Label (Alternate 2) |
☐ |
Used for list segmentation and reporting. |
label |
string |
Label |
☐ |
|
name_2 |
string |
Name (Alternate 2) |
☐ |
The template name. |
name |
string |
Name |
☐ |
The name of the token referenced in the templates. This must be unique for the specific template. It may only contain alphanumeric characters, periods, dashes, or underscores (. - _). |
objectPropertyName |
string |
Object Property Name |
☐ |
The name of the CRM object property. This will populate the CRM object property associated with the event. With enough of these, you can fully build CRM objects via the Timeline API. |
objectType |
string |
Object Type |
☐ |
The type of CRM object this template is for. [Contacts, companies, tickets, and deals] are supported. |
type |
string |
Type |
☐ |
The data type of the token. You can currently choose from [string, number, date, enumeration]. |
updatedAt_2 |
datetime |
{res:itgen_hubspot_updatedat_2} |
☐ |
The date and time that the Event Template was last updated, as an ISO 8601 timestamp. Will be null if the template was created before Feb 18th, 2020. |
updatedAt |
datetime |
Updated at |
☐ |
The date and time that the Event Template Token was last updated, as an ISO 8601 timestamp. Will be null if the template was created before Feb 18th, 2020. |
value |
string |
Value |
☐ |
|
18-12-2024 20:09 Version 24.1.33-BETA+5180
