Definições de evento
- Custom event definitions
- GETRecuperar definições de eventos
- POSTCriar definição de evento personalizado
- GETRecuperar uma definição de evento personalizada
- PATCHAtualizar uma definição de evento personalizado
- DELExcluir uma definição de evento
- POSTCriar uma propriedade para uma definição de evento
- PATCHAtualizar uma propriedade de evento personalizado existente
- DELExcluir uma propriedade de uma definição de evento personalizado
- GET
Conclusões de evento
curl --request POST \
--url https://api.hubapi.com/events/v3/event-definitions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "<string>",
"propertyDefinitions": [
{
"label": "<string>",
"type": "<string>",
"description": "<string>",
"name": "<string>",
"options": [
{
"displayOrder": 123,
"hidden": true,
"label": "<string>",
"value": "<string>",
"description": "<string>"
}
]
}
],
"description": "<string>",
"name": "<string>",
"primaryObject": "<string>"
}
'{
"archived": true,
"associations": [
{
"allowsCustomLabels": true,
"cardinality": "ONE_TO_MANY",
"category": "HUBSPOT_DEFINED",
"fromObjectTypeId": "<string>",
"hasAllAssociatedObjects": true,
"hasCascadingDeletes": true,
"hasUserEnforcedMaxFromObjectIds": true,
"hasUserEnforcedMaxToObjectIds": true,
"hidden": true,
"id": 123,
"inverseAllowsCustomLabels": true,
"inverseCardinality": "ONE_TO_MANY",
"inverseHasAllAssociatedObjects": true,
"inverseId": 123,
"inverseName": "<string>",
"isInversePrimary": true,
"isPrimary": true,
"maxFromObjectIds": 123,
"maxToObjectIds": 123,
"name": "<string>",
"portalUniqueIdentifier": "<string>",
"toObjectTypeId": "<string>",
"fromObjectType": "ABANDONED_CART",
"inverseLabel": "<string>",
"label": "<string>",
"toObjectType": "ABANDONED_CART"
}
],
"fullyQualifiedName": "<string>",
"id": "<string>",
"labels": {
"singular": "<string>",
"plural": "<string>"
},
"name": "<string>",
"objectTypeId": "<string>",
"properties": [
{
"description": "<string>",
"fieldType": "<string>",
"groupName": "<string>",
"label": "<string>",
"name": "<string>",
"options": [
{
"hidden": true,
"label": "<string>",
"value": "<string>",
"description": "<string>",
"displayOrder": 123
}
],
"type": "<string>",
"archived": true,
"archivedAt": "2023-11-07T05:31:56Z",
"calculated": true,
"calculationFormula": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdUserId": "<string>",
"dataSensitivity": "highly_sensitive",
"displayOrder": 123,
"externalOptions": true,
"formField": true,
"hasUniqueValue": true,
"hidden": false,
"hubspotDefined": true,
"modificationMetadata": {
"archivable": true,
"readOnlyDefinition": true,
"readOnlyValue": true,
"readOnlyOptions": true
},
"referencedObjectType": "<string>",
"sensitiveDataCategories": [
"<string>"
],
"showCurrencySymbol": true,
"updatedAt": "2023-11-07T05:31:56Z",
"updatedUserId": "<string>"
}
],
"comboEventRules": {
"composingRules": [
{
"count": 123,
"eventTypeId": "<string>",
"propertyFilters": [
{
"filterType": "PROPERTY",
"operation": {
"includeObjectsWithNoValueSet": true,
"operationType": "<string>",
"operator": "HAS_EVER_BEEN_EQUAL_TO",
"operatorName": "<string>",
"propertyType": "bool",
"value": true,
"defaultValue": "<string>"
},
"property": "<string>",
"frameworkFilterId": 123
}
],
"lookbackWindowDays": 123
}
],
"operationType": "AND",
"ruleBranches": "<array>"
},
"createdAt": "2023-11-07T05:31:56Z",
"createdUserId": 123,
"description": "<string>",
"primaryObject": "<string>",
"primaryObjectId": "<string>",
"trackingType": "CLICKED_ELEMENT"
}Criar definição de evento personalizado
Crie uma definição de evento personalizado.
curl --request POST \
--url https://api.hubapi.com/events/v3/event-definitions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "<string>",
"propertyDefinitions": [
{
"label": "<string>",
"type": "<string>",
"description": "<string>",
"name": "<string>",
"options": [
{
"displayOrder": 123,
"hidden": true,
"label": "<string>",
"value": "<string>",
"description": "<string>"
}
]
}
],
"description": "<string>",
"name": "<string>",
"primaryObject": "<string>"
}
'{
"archived": true,
"associations": [
{
"allowsCustomLabels": true,
"cardinality": "ONE_TO_MANY",
"category": "HUBSPOT_DEFINED",
"fromObjectTypeId": "<string>",
"hasAllAssociatedObjects": true,
"hasCascadingDeletes": true,
"hasUserEnforcedMaxFromObjectIds": true,
"hasUserEnforcedMaxToObjectIds": true,
"hidden": true,
"id": 123,
"inverseAllowsCustomLabels": true,
"inverseCardinality": "ONE_TO_MANY",
"inverseHasAllAssociatedObjects": true,
"inverseId": 123,
"inverseName": "<string>",
"isInversePrimary": true,
"isPrimary": true,
"maxFromObjectIds": 123,
"maxToObjectIds": 123,
"name": "<string>",
"portalUniqueIdentifier": "<string>",
"toObjectTypeId": "<string>",
"fromObjectType": "ABANDONED_CART",
"inverseLabel": "<string>",
"label": "<string>",
"toObjectType": "ABANDONED_CART"
}
],
"fullyQualifiedName": "<string>",
"id": "<string>",
"labels": {
"singular": "<string>",
"plural": "<string>"
},
"name": "<string>",
"objectTypeId": "<string>",
"properties": [
{
"description": "<string>",
"fieldType": "<string>",
"groupName": "<string>",
"label": "<string>",
"name": "<string>",
"options": [
{
"hidden": true,
"label": "<string>",
"value": "<string>",
"description": "<string>",
"displayOrder": 123
}
],
"type": "<string>",
"archived": true,
"archivedAt": "2023-11-07T05:31:56Z",
"calculated": true,
"calculationFormula": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdUserId": "<string>",
"dataSensitivity": "highly_sensitive",
"displayOrder": 123,
"externalOptions": true,
"formField": true,
"hasUniqueValue": true,
"hidden": false,
"hubspotDefined": true,
"modificationMetadata": {
"archivable": true,
"readOnlyDefinition": true,
"readOnlyValue": true,
"readOnlyOptions": true
},
"referencedObjectType": "<string>",
"sensitiveDataCategories": [
"<string>"
],
"showCurrencySymbol": true,
"updatedAt": "2023-11-07T05:31:56Z",
"updatedUserId": "<string>"
}
],
"comboEventRules": {
"composingRules": [
{
"count": 123,
"eventTypeId": "<string>",
"propertyFilters": [
{
"filterType": "PROPERTY",
"operation": {
"includeObjectsWithNoValueSet": true,
"operationType": "<string>",
"operator": "HAS_EVER_BEEN_EQUAL_TO",
"operatorName": "<string>",
"propertyType": "bool",
"value": true,
"defaultValue": "<string>"
},
"property": "<string>",
"frameworkFilterId": 123
}
],
"lookbackWindowDays": 123
}
],
"operationType": "AND",
"ruleBranches": "<array>"
},
"createdAt": "2023-11-07T05:31:56Z",
"createdUserId": 123,
"description": "<string>",
"primaryObject": "<string>",
"primaryObjectId": "<string>",
"trackingType": "CLICKED_ELEMENT"
}Produtos suportados
Produtos suportados
Marketing Hub -Enterprise
Sales Hub -Enterprise
Service Hub -Enterprise
Content Hub -EnterpriseEscopos Necessários
Escopos Necessários
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
Rótulo legível por humanos para o evento. Usado na interface do HubSpot
Lista de propriedades personalizadas em eventos
Mostrar atributos filhos
Mostrar atributos filhos
Rótulo legível por humanos para a propriedade. Usado na interface do HubSpot
O tipo de dados da propriedade. Pode ser um dos seguintes: [string, número, enumeração, data e hora]
Uma descrição da propriedade que será exibida como texto de ajuda no HubSpot.
Nome interno da propriedade, que deve ser usado ao referenciar a propriedade pela API.
Uma lista de opções disponíveis para a propriedade se for uma enumeração. OBSERVAÇÃO: este campo se aplica apenas a propriedades enumeradas.
Uma descrição do evento que será exibida como texto de ajuda no HubSpot.
Nome interno do evento, que deve ser usado ao referenciar o evento desta API de definições de evento. Se um nome não for fornecido, será gerado um com base no rótulo. O valor "name" também será usado para gerar automaticamente um "fullyQualifiedName" para a definição do evento, que você usará ao enviar conclusões para este evento.
O tipo de objeto a qual associar este evento. Pode ser CONTACT, COMPANY, DEAL, TICKET. Se primaryObject não for fornecido, associaremos o evento aos objetos CONTACT por padrão.
Response
successful operation
Mostrar atributos filhos
Mostrar atributos filhos
Whether custom labels can be used in the association.
The cardinality from the source object's perspective, either "ONE_TO_ONE" or "ONE_TO_MANY".
ONE_TO_MANY, ONE_TO_ONE The category of the association. Can be: "HUBSPOT_DEFINED", "USER_DEFINED", or "INTEGRATOR_DEFINED"
HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED The ID of the source object type (e.g., 0-1 for contacts).
Whether all potential linked objects are included in the association
Whether deletions in the association should cause cascading deletes to linked objects.
Whether a user has set a limit for the number of source objects.
Whether a user has set a limit for the number of destination objects.
Whether the association is hidden or not.
The unique ID of the associated object (e.g., a contact ID).
Whether the reverse association can also support custom labels.
The cardinality from the destination object's perspective, either "ONE_TO_ONE" or "ONE_TO_MANY".
ONE_TO_MANY, ONE_TO_ONE Whether all potential reverse linked objects are included in the association.
The unique ID for the inverse side of the association.
The name used to describe the inverse relationship in this association
Whether the inverse association is considered primary.
Whether the association is the primary link between the entities involved.
The maximum number of source object IDs allowed in the association.
The maximum number of destination object IDs allowed in the association.
For labeled association types, the internal name of the association.
A unique across-portal ID applied to the association.
The ID of the destination object type (e.g., 0-3 for deals).
The name of the source object type (e.g,. "DEAL" or "QUOTE").
ABANDONED_CART, ACCEPTANCE_TEST, AD, AD_ACCOUNT, AD_CAMPAIGN, AD_GROUP, AI_FORECAST, ALL_PAGES, APPROVAL, APPROVAL_STEP, ATTRIBUTION, AUDIENCE, AUTOMATION_JOURNEY, AUTOMATION_PLATFORM_FLOW, AUTOMATION_PLATFORM_FLOW_ACTION, BET_ALERT, BET_DELIVERABLE_SERVICE, BLOG_LISTING_PAGE, BLOG_POST, CALL, CAMPAIGN, CAMPAIGN_BUDGET_ITEM, CAMPAIGN_SPEND_ITEM, CAMPAIGN_STEP, CAMPAIGN_TEMPLATE, CAMPAIGN_TEMPLATE_STEP, CART, CASE_STUDY, CHATFLOW, CLIP, CMS_URL, COMBO_EVENT_CONFIGURATION, COMMERCE_PAYMENT, COMMUNICATION, COMPANY, CONTACT, CONTACT_CREATE_ATTRIBUTION, CONTENT, CONTENT_AUDIT, CONTENT_AUDIT_PAGE, CONVERSATION, CONVERSATION_INBOX, CONVERSATION_SESSION, CRM_OBJECTS_DUMMY_TYPE, CRM_PIPELINES_DUMMY_TYPE, CTA, CTA_VARIANT, DATA_PRIVACY_CONSENT, DATA_SYNC_STATE, DEAL, DEAL_CREATE_ATTRIBUTION, DEAL_REGISTRATION, DEAL_SPLIT, DISCOUNT, DISCOUNT_CODE, DISCOUNT_TEMPLATE, EMAIL, ENGAGEMENT, EXPORT, EXTERNAL_WEB_URL, FEE, FEEDBACK_SUBMISSION, FEEDBACK_SURVEY, FILE_MANAGER_FILE, FILE_MANAGER_FOLDER, FOLDER, FORECAST, FORM, FORM_SUBMISSION_INBOUNDDB, GOAL_TARGET, GOAL_TARGET_GROUP, GOAL_TEMPLATE, GSC_PROPERTY, HUB, IMPORT, INVOICE, KEYWORD, KNOWLEDGE_ARTICLE, LANDING_PAGE, LEAD, LINE_ITEM, MARKETING_CALENDAR, MARKETING_CAMPAIGN_UTM, MARKETING_EMAIL, MARKETING_EVENT, MARKETING_EVENT_ATTENDANCE, MARKETING_SMS, MEDIA_BRIDGE, MEETING_EVENT, MIC, NOTE, OBJECT_LIST, ORDER, OWNER, PARTNER_ACCOUNT, PARTNER_CLIENT, PARTNER_CLIENT_REVENUE, PARTNER_SERVICE, PAYMENT_LINK, PAYMENT_SCHEDULE, PAYMENT_SCHEDULE_INSTALLMENT, PERMISSIONS_TESTING, PLAYBOOK, PLAYBOOK_QUESTION, PLAYBOOK_SUBMISSION, PLAYBOOK_SUBMISSION_ANSWER, PLAYLIST, PLAYLIST_FOLDER, PODCAST_EPISODE, PORTAL, PORTAL_OBJECT_SYNC_MESSAGE, POSTAL_MAIL, PRIVACY_SCANNER_COOKIE, PRODUCT, PRODUCT_OR_FOLDER, PROPERTY_INFO, PUBLISHING_TASK, QUARANTINED_SUBMISSION, QUOTA, QUOTE, QUOTE_FIELD, QUOTE_MODULE, QUOTE_MODULE_FIELD, QUOTE_TEMPLATE, RESTORABLE_CRM_OBJECT, ROSTER, ROSTER_MEMBER, SALES_DOCUMENT, SALES_TASK, SALES_WORKLOAD, SALESFORCE_SYNC_ERROR, SCHEDULING_PAGE, SCHEMAS_BACKEND_TEST, SCORE_CONFIGURATION, SEQUENCE, SEQUENCE_ENROLLMENT, SEQUENCE_STEP, SEQUENCE_STEP_ENROLLMENT, SERVICE, SITE_PAGE, SNIPPET, SOCIAL_BROADCAST, SOCIAL_CHANNEL, SOCIAL_POST, SOCIAL_PROFILE, SOX_PROTECTED_DUMMY_TYPE, SOX_PROTECTED_TEST_TYPE, SUBMISSION_TAG, SUBSCRIPTION, TASK, TASK_TEMPLATE, TAX, TEMPLATE, TICKET, UNKNOWN, UNSUBSCRIBE, USER, VIEW, VIEW_BLOCK, WEB_INTERACTIVE The label used to describe the reverse relationship in an association.
The label given to an association.
The name of the destination object type (e.g,. "DEAL" or "QUOTE").
ABANDONED_CART, ACCEPTANCE_TEST, AD, AD_ACCOUNT, AD_CAMPAIGN, AD_GROUP, AI_FORECAST, ALL_PAGES, APPROVAL, APPROVAL_STEP, ATTRIBUTION, AUDIENCE, AUTOMATION_JOURNEY, AUTOMATION_PLATFORM_FLOW, AUTOMATION_PLATFORM_FLOW_ACTION, BET_ALERT, BET_DELIVERABLE_SERVICE, BLOG_LISTING_PAGE, BLOG_POST, CALL, CAMPAIGN, CAMPAIGN_BUDGET_ITEM, CAMPAIGN_SPEND_ITEM, CAMPAIGN_STEP, CAMPAIGN_TEMPLATE, CAMPAIGN_TEMPLATE_STEP, CART, CASE_STUDY, CHATFLOW, CLIP, CMS_URL, COMBO_EVENT_CONFIGURATION, COMMERCE_PAYMENT, COMMUNICATION, COMPANY, CONTACT, CONTACT_CREATE_ATTRIBUTION, CONTENT, CONTENT_AUDIT, CONTENT_AUDIT_PAGE, CONVERSATION, CONVERSATION_INBOX, CONVERSATION_SESSION, CRM_OBJECTS_DUMMY_TYPE, CRM_PIPELINES_DUMMY_TYPE, CTA, CTA_VARIANT, DATA_PRIVACY_CONSENT, DATA_SYNC_STATE, DEAL, DEAL_CREATE_ATTRIBUTION, DEAL_REGISTRATION, DEAL_SPLIT, DISCOUNT, DISCOUNT_CODE, DISCOUNT_TEMPLATE, EMAIL, ENGAGEMENT, EXPORT, EXTERNAL_WEB_URL, FEE, FEEDBACK_SUBMISSION, FEEDBACK_SURVEY, FILE_MANAGER_FILE, FILE_MANAGER_FOLDER, FOLDER, FORECAST, FORM, FORM_SUBMISSION_INBOUNDDB, GOAL_TARGET, GOAL_TARGET_GROUP, GOAL_TEMPLATE, GSC_PROPERTY, HUB, IMPORT, INVOICE, KEYWORD, KNOWLEDGE_ARTICLE, LANDING_PAGE, LEAD, LINE_ITEM, MARKETING_CALENDAR, MARKETING_CAMPAIGN_UTM, MARKETING_EMAIL, MARKETING_EVENT, MARKETING_EVENT_ATTENDANCE, MARKETING_SMS, MEDIA_BRIDGE, MEETING_EVENT, MIC, NOTE, OBJECT_LIST, ORDER, OWNER, PARTNER_ACCOUNT, PARTNER_CLIENT, PARTNER_CLIENT_REVENUE, PARTNER_SERVICE, PAYMENT_LINK, PAYMENT_SCHEDULE, PAYMENT_SCHEDULE_INSTALLMENT, PERMISSIONS_TESTING, PLAYBOOK, PLAYBOOK_QUESTION, PLAYBOOK_SUBMISSION, PLAYBOOK_SUBMISSION_ANSWER, PLAYLIST, PLAYLIST_FOLDER, PODCAST_EPISODE, PORTAL, PORTAL_OBJECT_SYNC_MESSAGE, POSTAL_MAIL, PRIVACY_SCANNER_COOKIE, PRODUCT, PRODUCT_OR_FOLDER, PROPERTY_INFO, PUBLISHING_TASK, QUARANTINED_SUBMISSION, QUOTA, QUOTE, QUOTE_FIELD, QUOTE_MODULE, QUOTE_MODULE_FIELD, QUOTE_TEMPLATE, RESTORABLE_CRM_OBJECT, ROSTER, ROSTER_MEMBER, SALES_DOCUMENT, SALES_TASK, SALES_WORKLOAD, SALESFORCE_SYNC_ERROR, SCHEDULING_PAGE, SCHEMAS_BACKEND_TEST, SCORE_CONFIGURATION, SEQUENCE, SEQUENCE_ENROLLMENT, SEQUENCE_STEP, SEQUENCE_STEP_ENROLLMENT, SERVICE, SITE_PAGE, SNIPPET, SOCIAL_BROADCAST, SOCIAL_CHANNEL, SOCIAL_POST, SOCIAL_PROFILE, SOX_PROTECTED_DUMMY_TYPE, SOX_PROTECTED_TEST_TYPE, SUBMISSION_TAG, SUBSCRIPTION, TASK, TASK_TEMPLATE, TAX, TEMPLATE, TICKET, UNKNOWN, UNSUBSCRIBE, USER, VIEW, VIEW_BLOCK, WEB_INTERACTIVE Mostrar atributos filhos
Mostrar atributos filhos
A summary of the property's purpose.
Determines how the property will appear in HubSpot's UI or on a form. Learn more in the properties API guide.
The name of the group to which the property is assigned.
The display label for the property.
The internal name for the property.
A list of valid options for the property. This field is required for enumerated properties.
Mostrar atributos filhos
Mostrar atributos filhos
Whether the option is displayed in HubSpot's UI.
A user-friendly label that identifies the option.
The actual value of the option.
A description of the option.
The position of the item relative to others in the list.
The data type of the property, such as string or number.
Whether the property is archived.
The timestamp when the property was archived, in ISO 8601 format.
Whether the property is a calculated field.
The formula used for calculated properties.
The timestamp when the property was created, in ISO 8601 format.
The ID of the user who created the property.
Indicates the sensitivity level of the property, such as "non_sensitive", "sensitive", or "highly_sensitive".
highly_sensitive, non_sensitive, sensitive The position of the item relative to others in the list.
Applicable only for enumeration type properties. Should be set to true with a 'referencedObjectType' of 'OWNER'. Otherwise false.
Whether the property can appear on forms.
Whether the property is a unique identifier property.
Whether or not the property will be hidden from the HubSpot UI. It's recommended that this be set to false for custom properties.
false
A boolean value set to true for HubSpot default properties.
Deprecated. Use externalOptionsReferenceType instead.
When sensitiveData is true, lists the type of sensitive data contained in the property (e.g., "HIPAA").
Whether to show the currency symbol in HubSpot's UI.
The timestamp when the property was last updated, in ISO 8601 format.
Mostrar atributos filhos
Mostrar atributos filhos
Mostrar atributos filhos
Mostrar atributos filhos
Mostrar atributos filhos
Mostrar atributos filhos
PROPERTY - bool
- number
- string
- datetime
- datetime-ranged
- datetime-comparative
- property-updated-comparative
- datetime-rolling
- rolling-property-updated
- enumeration
- alltypes
- number-ranged
- multistring
- date
- calendar-date
- timepoint
- rangedtime
Mostrar atributos filhos
Mostrar atributos filhos
HAS_EVER_BEEN_EQUAL_TO, HAS_NEVER_BEEN_EQUAL_TO, IS_EQUAL_TO, IS_NOT_EQUAL_TO bool AND, OR CLICKED_ELEMENT, COMBO_EVENT, CUSTOM_SCRIPT, IMPORT, MANUAL, PROPERTY_CHANGE, VISITED_URL, WEBHOOK