HubSpot API Data Model
WebhooksByAppIdSubscriptions |
Read event subscriptionsRetrieve event subscriptions for the specified app.
Catalog: Webhooks3
Schema: Subscriptions
Label: {res:itgen_hubspot_webhooksbyappidsubscriptions_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 WebhooksByAppIdSubscriptions. 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 app. |
Columns of Table Function
The columns of the table function WebhooksByAppIdSubscriptions are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
active |
boolean |
Active |
☐ |
Determines if the subscription is active or paused. |
createdAt |
datetime |
Created at |
☐ |
When this subscription was created. Formatted as milliseconds from the [Unix epoch](#). |
eventType |
string |
Event Type |
☐ |
Type of event to listen for. Can be one of `create`, `delete`, `deletedForPrivacy`, or `propertyChange`. |
id |
string |
ID |
☐ |
The unique ID of the subscription. |
objectTypeId |
string |
Ojbect Type ID |
☐ |
|
propertyName |
string |
Property Name |
☐ |
The internal name of the property being monitored for changes. Only applies when `eventType` is `propertyChange`. |
updatedAt |
datetime |
Updated at |
☐ |
When this subscription was last updated. Formatted as milliseconds from the [Unix epoch](#). |
18-12-2024 20:09 Version 24.1.33-BETA+5180
