curl --request GET \
--url https://api.hubapi.com/events/v3/event-definitions \
--header 'Authorization: Bearer <token>'
{
"total": 123,
"paging": {
"next": {
"link": "",
"after": ""
}
},
"results": [
{
"associations": [
{
"inverseLabel": "",
"hidden": false,
"allowsCustomLabels": false,
"maxFromObjectIds": 123,
"inverseAllowsCustomLabels": false,
"isPrimary": false,
"hasUserEnforcedMaxToObjectIds": false,
"hasUserEnforcedMaxFromObjectIds": false,
"id": 123,
"toObjectTypeId": "",
"inverseCardinality": "",
"maxToObjectIds": 123,
"hasCascadingDeletes": false,
"fromObjectType": "",
"toObjectType": "",
"label": "",
"inverseId": 123,
"cardinality": "",
"inverseName": "",
"hasAllAssociatedObjects": false,
"inverseHasAllAssociatedObjects": false,
"fromObjectTypeId": "",
"portalUniqueIdentifier": "",
"isInversePrimary": false,
"name": "",
"category": ""
}
],
"objectTypeId": "<string>",
"createdUserId": 123,
"trackingType": "VISITED_URL",
"description": "<string>",
"primaryObjectId": "<string>",
"comboEventRules": {
"operationType": "AND",
"composingRules": [
{
"lookbackWindowDays": 123,
"eventTypeId": "<string>",
"propertyFilters": [
{
"frameworkFilterId": 123,
"property": "<string>",
"filterType": "PROPERTY",
"operation": {
"includeObjectsWithNoValueSet": true,
"defaultValue": "<string>",
"propertyType": "bool",
"operationType": "<string>",
"value": true,
"operatorName": "<string>",
"operator": "IS_EQUAL_TO"
}
}
],
"count": 123
}
],
"ruleBranches": [
{}
]
},
"fullyQualifiedName": "<string>",
"primaryObject": "<string>",
"labels": {
"plural": "<string>",
"singular": "<string>"
},
"archived": true,
"createdAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"id": "<string>",
"properties": [
{
"hidden": false,
"displayOrder": 123,
"description": "",
"showCurrencySymbol": false,
"type": "",
"hubspotDefined": false,
"createdAt": "2023-11-07T05:31:56Z",
"archived": false,
"options": "",
"hasUniqueValue": false,
"calculated": false,
"externalOptions": false,
"updatedAt": "2023-11-07T05:31:56Z",
"createdUserId": "",
"modificationMetadata": {
"readOnlyOptions": true,
"readOnlyValue": true,
"readOnlyDefinition": true,
"archivable": true
},
"sensitiveDataCategories": "",
"label": "",
"formField": false,
"dataSensitivity": "",
"archivedAt": "2023-11-07T05:31:56Z",
"groupName": "",
"referencedObjectType": "",
"name": "",
"calculationFormula": "",
"fieldType": "",
"updatedUserId": "<string>"
}
]
}
]
}
Recuperar definiciones de evento personalizado existentes.
curl --request GET \
--url https://api.hubapi.com/events/v3/event-definitions \
--header 'Authorization: Bearer <token>'
{
"total": 123,
"paging": {
"next": {
"link": "",
"after": ""
}
},
"results": [
{
"associations": [
{
"inverseLabel": "",
"hidden": false,
"allowsCustomLabels": false,
"maxFromObjectIds": 123,
"inverseAllowsCustomLabels": false,
"isPrimary": false,
"hasUserEnforcedMaxToObjectIds": false,
"hasUserEnforcedMaxFromObjectIds": false,
"id": 123,
"toObjectTypeId": "",
"inverseCardinality": "",
"maxToObjectIds": 123,
"hasCascadingDeletes": false,
"fromObjectType": "",
"toObjectType": "",
"label": "",
"inverseId": 123,
"cardinality": "",
"inverseName": "",
"hasAllAssociatedObjects": false,
"inverseHasAllAssociatedObjects": false,
"fromObjectTypeId": "",
"portalUniqueIdentifier": "",
"isInversePrimary": false,
"name": "",
"category": ""
}
],
"objectTypeId": "<string>",
"createdUserId": 123,
"trackingType": "VISITED_URL",
"description": "<string>",
"primaryObjectId": "<string>",
"comboEventRules": {
"operationType": "AND",
"composingRules": [
{
"lookbackWindowDays": 123,
"eventTypeId": "<string>",
"propertyFilters": [
{
"frameworkFilterId": 123,
"property": "<string>",
"filterType": "PROPERTY",
"operation": {
"includeObjectsWithNoValueSet": true,
"defaultValue": "<string>",
"propertyType": "bool",
"operationType": "<string>",
"value": true,
"operatorName": "<string>",
"operator": "IS_EQUAL_TO"
}
}
],
"count": 123
}
],
"ruleBranches": [
{}
]
},
"fullyQualifiedName": "<string>",
"primaryObject": "<string>",
"labels": {
"plural": "<string>",
"singular": "<string>"
},
"archived": true,
"createdAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"id": "<string>",
"properties": [
{
"hidden": false,
"displayOrder": 123,
"description": "",
"showCurrencySymbol": false,
"type": "",
"hubspotDefined": false,
"createdAt": "2023-11-07T05:31:56Z",
"archived": false,
"options": "",
"hasUniqueValue": false,
"calculated": false,
"externalOptions": false,
"updatedAt": "2023-11-07T05:31:56Z",
"createdUserId": "",
"modificationMetadata": {
"readOnlyOptions": true,
"readOnlyValue": true,
"readOnlyDefinition": true,
"archivable": true
},
"sensitiveDataCategories": "",
"label": "",
"formField": false,
"dataSensitivity": "",
"archivedAt": "2023-11-07T05:31:56Z",
"groupName": "",
"referencedObjectType": "",
"name": "",
"calculationFormula": "",
"fieldType": "",
"updatedUserId": "<string>"
}
]
}
]
}
behavioral_events.event_definitions.read_write
The access token received from the authorization server in the OAuth 2.0 flow.
Caracteres incluidos en el nombre del evento que el usuario está buscando. Esta búsqueda es una búsqueda sencilla de tipo "contiene", no se buscan coincidencias parciales.
El token del cursor de paginación del último recurso leído con éxito se devolverá como la propiedad JSON paging.next.after
de una respuesta paginada que contenga más resultados.
El número máximo de resultados que se mostrarán por página.
successful operation
The response is of type object
.