HubSpot Events Manage Event Definitions API

openapi: 3.0.1
info:
  title: HubSpot Events Manage Event Definitions
  description: Basepom for all HubSpot Projects
  version: 2026-09
  x-hubspot-product-tier-requirements:
    marketing: ENTERPRISE
    sales: ENTERPRISE
    service: ENTERPRISE
    cms: ENTERPRISE
    commerce: ENTERPRISE
    crmHub: ENTERPRISE
    dataHub: ENTERPRISE
servers:
- url: https://api.hubapi.com
tags:
- name: Advanced
- name: Basic
- name: Batch
paths:
  /events/v3/2026-09/event-definitions:
    get:
      tags:
      - Basic
      summary: Retrieve event definitions
      description: Retrieve existing custom event definitions.
      operationId: get-/events/v3/2026-09/event-definitions
      parameters:
      - name: after
        in: query
        description: The paging cursor token of the last successfully read resource will be returned as
          the `paging.next.after` JSON property of a paged response containing more results.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: includeProperties
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: limit
        in: query
        description: The maximum number of results to display per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: searchString
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: sortOrder
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponseWithTotalExternalBehavioralEventTypeDefinition'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - behavioral_events.event_definitions.read_write
    post:
      tags:
      - Basic
      summary: Create custom event definition
      description: Create a custom event definition.
      operationId: post-/events/v3/2026-09/event-definitions
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalBehavioralEventTypeDefinitionEgg'
        required: true
      responses:
        '201':
          description: successful operation
          headers:
            Location:
              description: URL of the newly created resource
              style: simple
              explode: false
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalBehavioralEventTypeDefinition'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - behavioral_events.event_definitions.read_write
  /events/v3/2026-09/event-definitions/{eventName}:
    get:
      tags:
      - Basic
      summary: Retrieve a custom event definition
      description: Fetch a single custom event definition by name.
      operationId: get-/events/v3/2026-09/event-definitions/{eventName}
      parameters:
      - name: eventName
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalBehavioralEventTypeDefinition'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - behavioral_events.event_definitions.read_write
    delete:
      tags:
      - Basic
      summary: Delete an event definition
      description: Delete a custom event definition by name.
      operationId: delete-/events/v3/2026-09/event-definitions/{eventName}
      parameters:
      - name: eventName
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '204':
          description: No content
          content: {}
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - behavioral_events.event_definitions.read_write
    patch:
      tags:
      - Basic
      summary: Update a custom event definition
      description: Update a specific custom event definition by name.
      operationId: patch-/events/v3/2026-09/event-definitions/{eventName}
      parameters:
      - name: eventName
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalBehavioralEventTypeDefinitionPatch'
        required: true
      responses:
        '201':
          description: successful operation
          headers:
            Location:
              description: URL of the newly created resource
              style: simple
              explode: false
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalBehavioralEventTypeDefinition'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - behavioral_events.event_definitions.read_write
  /events/v3/2026-09/event-definitions/{eventName}/property:
    post:
      tags:
      - Advanced
      summary: Create a property for an event definition
      description: Create a new property for an existing event definition.
      operationId: post-/events/v3/2026-09/event-definitions/{eventName}/property
      parameters:
      - name: eventName
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalBehavioralEventPropertyCreate'
        required: true
      responses:
        '201':
          description: successful operation
          headers:
            Location:
              description: URL of the newly created resource
              style: simple
              explode: false
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Property'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - behavioral_events.event_definitions.read_write
  /events/v3/2026-09/event-definitions/{eventName}/property/{propertyName}:
    delete:
      tags:
      - Basic
      summary: Delete a property from a custom event definition
      description: Delete an existing property from a custom event definition.
      operationId: delete-/events/v3/2026-09/event-definitions/{eventName}/property/{propertyName}
      parameters:
      - name: eventName
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: propertyName
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '204':
          description: No content
          content: {}
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - behavioral_events.event_definitions.read_write
    patch:
      tags:
      - Basic
      summary: Update an existing custom event property
      description: Update an existing property in a custom event definition.
      operationId: patch-/events/v3/2026-09/event-definitions/{eventName}/property/{propertyName}
      parameters:
      - name: eventName
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: propertyName
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalBehavioralEventPropertyDefinitionPatch'
        required: true
      responses:
        '201':
          description: successful operation
          headers:
            Location:
              description: URL of the newly created resource
              style: simple
              explode: false
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Property'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - behavioral_events.event_definitions.read_write
  /events/v3/2026-09/send/batch:
    post:
      tags:
      - Batch
      operationId: post-/events/v3/2026-09/send/batch_/events/v3/send/batch
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchedBehavioralEventHttpCompletionRequest'
        required: true
      responses:
        '204':
          description: No content
          content: {}
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - analytics.behavioral_events.send
      x-hubspot-rate-limit-exemptions:
      - daily
      - ten-secondly
components:
  schemas:
    AbsoluteComparativeTimestampRefineBy:
      title: AbsoluteComparativeTimestampRefineBy
      required:
      - comparison
      - timestamp
      - type
      type: object
      properties:
        comparison:
          type: string
          enum:
          - AFTER
          - BEFORE
        timestamp:
          type: integer
          format: int64
        type:
          type: string
          default: AbsoluteComparativeTimestampRefineBy
          enum:
          - AbsoluteComparativeTimestampRefineBy
      x-hubspot-sub-type-impl: true
    AbsoluteRangedTimestampRefineBy:
      title: AbsoluteRangedTimestampRefineBy
      required:
      - lowerTimestamp
      - rangeType
      - type
      - upperTimestamp
      type: object
      properties:
        lowerTimestamp:
          type: integer
          format: int64
        rangeType:
          type: string
          enum:
          - BETWEEN
          - NOT_BETWEEN
        type:
          type: string
          default: AbsoluteRangedTimestampRefineBy
          enum:
          - AbsoluteRangedTimestampRefineBy
        upperTimestamp:
          type: integer
          format: int64
      x-hubspot-sub-type-impl: true
    AllHistoryRefineBy:
      title: AllHistoryRefineBy
      required:
      - type
      type: object
      properties:
        type:
          type: string
          default: AllHistoryRefineBy
          enum:
          - AllHistoryRefineBy
      x-hubspot-sub-type-impl: true
    AllPropertyTypesOperation:
      title: alltypes
      required:
      - coalescingRefineBy
      - includeObjectsWithNoValueSet
      - operationType
      - operator
      - operatorName
      - propertyType
      type: object
      properties:
        coalescingRefineBy:
          oneOf:
          - $ref: '#/components/schemas/NumOccurrencesRefineBy'
          - $ref: '#/components/schemas/SetOccurrencesRefineBy'
        defaultValue:
          type: string
        includeObjectsWithNoValueSet:
          type: boolean
        operationType:
          type: string
        operator:
          type: string
          enum:
          - IS_BLANK
          - IS_KNOWN
          - IS_NOT_BLANK
          - IS_UNKNOWN
        operatorName:
          type: string
        propertyType:
          type: string
          default: alltypes
          enum:
          - alltypes
        pruningRefineBy:
          oneOf:
          - $ref: '#/components/schemas/RelativeComparativeTimestampRefineBy'
          - $ref: '#/components/schemas/RelativeRangedTimestampRefineBy'
          - $ref: '#/components/schemas/AbsoluteComparativeTimestampRefineBy'
          - $ref: '#/components/schemas/AbsoluteRangedTimestampRefineBy'
          - $ref: '#/components/schemas/AllHistoryRefineBy'
          - $ref: '#/components/schemas/TimePointOperation'
          - $ref: '#/components/schemas/RangedTimeOperation'
        renderSpec:
          type: string
      x-hubspot-sub-type-impl: true
    AssociationDefinition:
      required:
      - allowsCustomLabels
      - cardinality
      - category
      - fromObjectTypeId
      - hasAllAssociatedObjects
      - hasCascadingDeletes
      - hasUserEnforcedMaxFromObjectIds
      - hasUserEnforcedMaxToObjectIds
      - hidden
      - id
      - inverseAllowsCustomLabels
      - inverseCardinality
      - inverseHasAllAssociatedObjects
      - inverseId
      - inverseName
      - isDefault
      - isInversePrimary
      - isPrimary
      - maxFromObjectIds
      - maxToObjectIds
      - name
      - portalUniqueIdentifier
      - readOnly
      - toObjectTypeId
      type: object
      properties:
        allowsCustomLabels:
          type: boolean
          description: Whether custom labels can be used in the association.
        cardinality:
          type: string
          description: The cardinality from the source object's perspective, either "ONE_TO_ONE" or "ONE_TO_MANY".
          enum:
          - ONE_TO_MANY
          - ONE_TO_ONE
        category:
          type: string
          description: The error category
          enum:
          - HUBSPOT_DEFINED
          - INTEGRATOR_DEFINED
          - USER_DEFINED
          - WORK
        fromObjectType:
          type: string
          description: The name of the source object type (e.g,. "DEAL" or "QUOTE").
          enum:
          - 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
          - PROSPECTING_AGENT_CONTACT_ASSIGNMENT
          - 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
        fromObjectTypeId:
          type: string
          description: The ID of the source object type (e.g., 0-1 for contacts).
        hasAllAssociatedObjects:
          type: boolean
          description: Whether all potential linked objects are included in the association
        hasCascadingDeletes:
          type: boolean
          description: Whether deletions in the association should cause cascading deletes to linked objects.
        hasUserEnforcedMaxFromObjectIds:
          type: boolean
          description: Whether a user has set a limit for the number of source objects.
        hasUserEnforcedMaxToObjectIds:
          type: boolean
          description: Whether a user has set a limit for the number of destination objects.
        hidden:
          type: boolean
          description: Whether the association is hidden or not.
        hiddenReason:
          type: string
          enum:
          - DEFAULT
          - INTERNAL
          - USER_CONFIGURED
        id:
          type: integer
          description: The unique ID of the associated object (e.g., a contact ID).
          format: int32
        inverseAllowsCustomLabels:
          type: boolean
          description: Whether the reverse association can also support custom labels.
        inverseCardinality:
          type: string
          description: The cardinality from the destination object's perspective, either "ONE_TO_ONE"
            or "ONE_TO_MANY".
          enum:
          - ONE_TO_MANY
          - ONE_TO_ONE
        inverseHasAllAssociatedObjects:
          type: boolean
          description: Whether all potential reverse linked objects are included in the association.
        inverseId:
          type: integer
          description: The unique ID for the inverse side of the association.
          format: int32
        inverseLabel:
          type: string
          description: The label used to describe the reverse relationship in an association.
        inverseName:
          type: string
          description: The name used to describe the inverse relationship in this association
        isDefault:
          type: boolean
        isInversePrimary:
          type: boolean
          description: Whether the inverse association is considered primary.
        isPrimary:
          type: boolean
          description: Whether the association is the primary link between the entities involved.
        label:
          type: string
          description: The label given to an association.
        maxFromObjectIds:
          type: integer
          description: The maximum number of source object IDs allowed in the association.
          format: int32
        maxToObjectIds:
          type: integer
          description: The maximum number of destination object IDs allowed in the association.
          format: int32
        name:
          type: string
          description: For labeled association types, the internal name of the association.
        portalUniqueIdentifier:
          type: string
          description: A unique across-portal ID applied to the association.
        readOnly:
          type: boolean
        toObjectType:
          type: string
          description: The name of the destination object type (e.g,. "DEAL" or "QUOTE").
          enum:
          - 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
          - PROSPECTING_AGENT_CONTACT_ASSIGNMENT
          - 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
        toObjectTypeId:
          type: string
          description: The ID of the destination object type (e.g., 0-3 for deals).
      description: The definition of an association
    BatchedBehavioralEventHttpCompletionRequest:
      required:
      - inputs
      type: object
      properties:
        inputs:
          type: array
          items:
            $ref: '#/components/schemas/BehavioralEventHttpCompletionRequest'
    BehavioralEventHttpCompletionRequest:
      required:
      - eventName
      - properties
      type: object
      properties:
        email:
          type: string
          description: Email of visitor
        eventName:
          type: string
          description: Internal name of the event-type to trigger
        objectId:
          type: string
          description: The object id that this event occurred on. Could be a contact id or a visitor id.
        occurredAt:
          type: string
          description: The time when this event occurred (if any). If this isn't set, the current time
            will be used
          format: date-time
        properties:
          type: object
          additionalProperties:
            type: string
          description: Map of properties for the event in the format property internal name - property
            value
        utk:
          type: string
          description: User token
        uuid:
          type: string
    BehavioralEventTypeDefinitionLabels:
      required:
      - singular
      type: object
      properties:
        plural:
          type: string
        singular:
          type: string
    BoolPropertyOperation:
      title: bool
      required:
      - includeObjectsWithNoValueSet
      - operationType
      - operator
      - operatorName
      - propertyType
      - value
      type: object
      properties:
        defaultValue:
          type: string
        includeObjectsWithNoValueSet:
          type: boolean
        operationType:
          type: string
        operator:
          type: string
          enum:
          - HAS_EVER_BEEN_EQUAL_TO
          - HAS_NEVER_BEEN_EQUAL_TO
          - IS_EQUAL_TO
          - IS_NOT_EQUAL_TO
        operatorName:
          type: string
        propertyType:
          type: string
          default: bool
          enum:
          - bool
        renderSpec:
          type: string
        value:
          type: boolean
      x-hubspot-sub-type-impl: true
    CalendarDatePropertyOperation:
      title: calendar-date
      required:
      - includeObjectsWithNoValueSet
      - operationType
      - operator
      - operatorName
      - propertyType
      - timeUnit
      - timeUnitCount
      - useFiscalYear
      type: object
      properties:
        defaultValue:
          type: string
        fiscalYearStart:
          type: string
          enum:
          - APRIL
          - AUGUST
          - DECEMBER
          - FEBRUARY
          - JANUARY
          - JULY
          - JUNE
          - MARCH
          - MAY
          - NOVEMBER
          - OCTOBER
          - SEPTEMBER
        includeObjectsWithNoValueSet:
          type: boolean
        operationType:
          type: string
        operator:
          type: string
          enum:
          - IN_LAST_TIME_UNIT
          - IN_LAST_TIME_UNIT_SO_FAR
          - IN_NEXT_TIME_UNIT
          - IN_THIS_TIME_UNIT
          - IN_THIS_TIME_UNIT_SO_FAR
        operatorName:
          type: string
        propertyType:
          type: string
          default: calendar-date
          enum:
          - calendar-date
        renderSpec:
          type: string
        timeUnit:
          type: string
          enum:
          - DAY
          - MONTH
          - QUARTER
          - WEEK
          - YEAR
        timeUnitCount:
          type: integer
          format: int32
        useFiscalYear:
          type: boolean
      x-hubspot-sub-type-impl: true
    CollectionResponseWithTotalExternalBehavioralEventTypeDefinition:
      required:
      - results
      - total
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/Paging'
        results:
          type: array
          items:
            $ref: '#/components/schemas/ExternalBehavioralEventTypeDefinition'
        total:
          type: integer
          format: int32
    ComboEventRule:
      required:
      - count
      - eventTypeId
      - propertyFilters
      type: object
      properties:
        count:
          type: integer
          format: int32
        eventTypeId:
          type: string
        lookbackWindowDays:
          type: integer
          format: int32
        propertyFilters:
          type: array
          items:
            $ref: '#/components/schemas/PropertyFilter'
    ComboEventRuleBranch:
      required:
      - composingRules
      - operationType
      - ruleBranches
      type: object
      properties:
        composingRules:
          type: array
          items:
            $ref: '#/components/schemas/ComboEventRule'
        operationType:
          type: string
          enum:
          - AND
          - OR
        ruleBranches:
          type: array
          items:
            $ref: '#/components/schemas/ComboEventRuleBranch'
    ComparativeBoolPropertyOperation:
      title: bool-comparative
      required:
      - comparisonPropertyName
      - includeObjectsWithNoValueSet
      - operationType
      - operator
      - operatorName
      - propertyType
      type: object
      properties:
        comparisonPropertyName:
          type: string
        defaultValue:
          type: string
        includeObjectsWithNoValueSet:
          type: boolean
        operationType:
          type: string
        operator:
          type: string
          enum:
          - IS_EQUAL_TO
          - IS_NOT_EQUAL_TO
        operatorName:
          type: string
        propertyType:
          type: string
          default: bool-comparative
          enum:
          - bool-comparative
        renderSpec:
          type: string
      x-hubspot-sub-type-impl: true
    ComparativeDatePropertyOperation:
      title: datetime-comparative
      required:
      - comparisonPropertyName
      - includeObjectsWithNoValueSet
      - operationType

# --- truncated at 32 KB (80 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/openapi/hubspot-events-manage-event-definitions-api-openapi.yml