HubSpot Custom Timeline Events: When Labels Lose Their Last Word

Hey ESHOPMAN community! As experts deeply embedded in the world of HubSpot and e-commerce, we know how crucial every piece of data is. The HubSpot timeline, in particular, is a goldmine for understanding customer interactions. It's where sales, marketing, and service all come together to paint a complete picture of your customer's journey. But what happens when that picture gets a little blurry?

We recently stumbled upon a fascinating, albeit frustrating, discussion in the HubSpot Community that perfectly illustrates the kind of nuanced challenges developers and RevOps teams can face when integrating custom data. The original poster highlighted an issue where custom timeline event labels were mysteriously losing their final word when rendered in a contact's activity timeline. Imagine setting up a detailed event like "LinkedIn message replied by User" only to see it appear as "LinkedIn message replied User." Small detail, big impact on clarity!

The Curious Case of the Truncated Label

The problem surfaced with an enumeration property within a custom app event definition. Here's a snippet of the original event definition:

{
  "uid": "linkedin_conversation_message",
  "type": "app-event",
  "config": {
    "name": "LinkedIn conversation message",
    "objectType": "CONTACT",
    "headerTemplate": "{{type}} {{userName}}",
    "detailTemplate": "{{text}}",
    "properties": [
      {
        "name": "userName",
        "label": "Sender name",
        "type": "string"
      },
      {
        "name": "type",
        "label": "Message direction",
        "description": "Message direction relative to the Dripify user",
        "type": "enumeration",
        "options": [
          {
            "value": "LINKEDIN_SENT",
            "label": "LinkedIn message sent to"
          },
          {
            "value": "LINKEDIN_REPLIED",
            "label": "LinkedIn message replied by" // with BY
          }
        ]
      },
      {
        "name": "text",
        "label": "Message text",
        "description": "Full text of the message",
        "type": "string"
      }
    ]
  }
}

Notice the options array within the type enumeration property. Each option uses a label field to define the display text, as per HubSpot's documentation. Yet, the rendered output was consistently dropping the last word ("to" or "by").

Community Troubleshooting: A Deep Dive into HubSpot's Docs and CLI

The community quickly jumped in to help. Initial thoughts from a community member leaned towards a "small UI formatting issue" rather than a problem with the event definition itself, suggesting more details to help the HubSpot team reproduce it.

The original poster confirmed the consistency of the issue across multiple enumeration values, providing a sample payload that clearly showed the truncation pattern:

• "LinkedIn message sent to" → "LinkedIn message sent"
• "LinkedIn message replied by" → "LinkedIn message replied"

Then came a crucial suggestion from another community manager: perhaps the issue was with using label for enumeration options, and that name should be used instead, referencing the app events reference. The proposed change looked like this:

"options": [
  {
    "value": "LINKEDIN_SENT",
    "name": "LinkedIn message sent to"
  },
  {
    "value": "LINKEDIN_REPLIED",
    "name": "LinkedIn message replied by"
  }
]

This seemed like a plausible solution, given that property definitions often use name. However, this is where the plot thickened. The original poster tested this suggestion and found that HubSpot CLI validation failed, both when using name only and when using both name and label. The errors explicitly stated:

• Missing required field: 'config.properties.1.options.0.label'
• config.properties.1.options.0: must NOT have additional properties - additionalProperty: name

This clearly indicated that label is indeed the required field for enumeration options, and name is not recognized in this context. The original poster also pointed out that HubSpot's official documentation consistently uses label for enumeration definitions, further solidifying that the original approach was correct according to the docs.

The Current State: A Discrepancy to Address

As the discussion concluded, it became evident that the issue wasn't a simple developer mistake but rather a potential discrepancy between HubSpot's documentation, its CLI validation, and the actual rendering behavior in the UI. The community manager acknowledged this, reiterating that value and label are the documented and expected fields for enumeration options.

For HubSpot users, RevOps, and marketers integrating custom events, this highlights a critical point: always follow the official documentation. If you encounter behavior that contradicts the documentation or CLI validation, it's likely a platform bug or an inconsistency that needs to be reported to HubSpot support. Maintaining accurate and complete data in your CRM is paramount, especially for a customer centric ecommerce platform where every interaction informs your strategy.

Until HubSpot addresses this specific rendering bug, developers might need to consider workarounds like shortening labels to avoid critical words being truncated, or restructuring the headerTemplate to pull in other properties that clearly convey the full meaning. However, the best course of action is to report the issue and provide all relevant details to HubSpot support, ensuring they can investigate and implement a fix.

Accurate timeline data is the backbone of effective RevOps and personalized customer experiences. Don't let a missing word derail your understanding of customer engagement.

ESHOPMAN Team Comment

This discussion perfectly illustrates the challenges of integrating custom data into HubSpot, even with robust documentation. For e-commerce businesses, precise timeline events are non-negotiable for understanding customer behavior and optimizing sales funnels. We strongly believe that such discrepancies need swift resolution from HubSpot to ensure data integrity and empower a truly customer-centric approach. At ESHOPMAN, we focus on providing a seamless storefront experience that leverages HubSpot's full power, and reliable data display is fundamental to that promise.

Keep an eye on the HubSpot Community for updates on issues like this, and remember that a proactive approach to data quality will always pay dividends for your e-commerce operations.