July 2024 Rollup
It is time for July 2024 Developer Rollup. From webhooks to memberships, we have a lot going on.
I hate to be the bearer of bad news, but July has come to an end and for the folks in the northern hemisphere, this means that we are in the final throws of summer. We here at HubSpot realize that this news can be difficult to handle so in an effort to distract you from the pain of summer disappearing, we are pleased to present to you some shiny new toys in the July 2024 Developer Rollup!
- Custom Events with Webhooks
- Filter By Account ID in Developer Public App Logs
- Customizable Membership Registration and Authentication Emails
- Editable System Pages for Memberships
- Changelog Update: Revised Filtering Capabilities and Error Messaging in HubSpot's Search API
- Reminder: HubSpot CLI requires Node v18+. If using the GitHub deploy action, update to v1.7
- Module Placeholder for Programmable Email
- HubDB Rich Text columns now have a source code button
- New Calls to action (CTA) API
- Preview your theme locally using the CLI
- New Customer Feedback tab now available in App Marketplace Dashboard
- Updated list of available “Objects” in shared data section within app listing flow
- Secrets in the CLI can now be up to 3000 characters in length
- Membership Templates now accepted in submissions within the Template Marketplace
- CMS React Data Fetching
- StatusTag Component
- Introducing: Overlays for better pop-up management
- App Cards (UI Extensions) for Help Desk Ticket Sidebars
Developer Updates for July 2024
Custom Events with Webhooks
Webhooks provide the flexibility to pull data from third-party systems/apps to report, segment, and trigger workflows directly in HubSpot using third-party data. Previously, webhooks could only trigger Workflows, but now you can create and manage custom events created via Workflows for use across all of HubSpot.
What's changing?
Now, with the ability to create and manage custom events, users can leverage data more effectively across HubSpot tools. Custom events created via webhooks can be used in lists, reports, and other analytical tools within HubSpot, enhancing data accessibility and usability.
Below are some of the key highlights of what’s changing.
- Creation of Custom Events
Users can now create custom events within HubSpot using data received from webhooks. These events can be defined within the Custom Events app and associated with various third-party activities.
- Management of Custom Events
Once created, these custom events can be managed within HubSpot. Users can view, edit, and delete custom events as needed.
- Utilization Across HubSpot Tools
Custom events created via webhooks can now be used in other HubSpot tools, such as lists and reports. This allows for more robust reporting and segmentation capabilities.
- Enhanced Integration Flexibility
The new functionality extends the ability to integrate data from third-party systems without requiring extensive coding or additional applications. Users can continue using webhooks to trigger workflows while also generating custom events.
This update is designed to improve the overall efficiency and capabilities of data integration and management within HubSpot, empowering users to make more informed decisions based on comprehensive data insights.
Filter By Account ID in Developer Public App Logs
You can now filter by Account ID (also called Hub ID) when viewing the logs for your public apps.
This new filter is supported for all logging types for your app. Simply go to the specific monitoring tab you need, select Account ID from the search dropdown, and type the account ID in the search box.
Please note that at this time this only supports an exact match, so you will need to type the full ID before you will see results.
Customizable Membership Registration and Authentication Emails
To help businesses improve branding consistency and enhance registration and login experiences, we are now allowing customization of various email templates using the marketing email editor. This includes registration follow-up emails, self-registration confirmation emails, and password-less authentication emails, all of which were previously using standard templates.
Businesses can now ensure consistency with their branding and improve registration completion rates by customizing these email templates.
How to Customize:
- Access Email Customization:
- Navigate to settings > tools > website > private content (for self-registration confirmation and password-less auth emails).
- Or, navigate to settings > tools > content > private content (for registration follow-up emails).
- Select the emails tab.
- Select the Email Template:
- For registration follow-up emails, scroll down to the "Follow-Up Emails" section and check the box to enable the functionality if you haven't already.
- For all email types, navigate to the desired email template (self-registration confirmation, password-less auth, or follow-up emails).
- Create Custom Email:
- In the email preview, select actions > create.
- You will be taken to the marketing email editor for email creation and editing.
- Once complete, your newly created email template will be selectable from the template dropdown above the email preview.
With these enhancements, all accounts with access to private content can now fully customize their email communications, ensuring a seamless and branded experience for their users.
Editable System Pages for Memberships
All membership system pages are now customizable through the design manager and CLI with this update. We have added customization for the following pages:
- Email confirmation (seen after completing self-registration)
- Email verification (seen clicking on the confirmation link from the email for self-registration)
- Password-less authentication confirmation (seen after requesting a password-less authentication link)
Changelog Update: Revised Filtering Capabilities and Error Messaging in HubSpot's Search API
We are providing an important update to the recently announced enhancements to our Search API filtering capabilities, which are scheduled to go live on August 26th, 2024. Based on further assessments, we have decided to revise the limits on filters to ensure a safer and more stable implementation. The new limits, while still an improvement, offer a balanced approach to enhanced search functionality.
Existing Limits
- Filter Groups: 3 filter groups
- Filters per Filter Group: 3 filters per filter group
- Total Filters: 9 total filters across filter groups
Current Limits Announced
- Filter Groups: 5 filter groups
- Filters per Filter Group: 10 filters per filter group
- Total Filters: 25 total filters across filter groups
Proposed Updated Limits (Effective from August 26, 2024)
- Filter Groups: 5 filter groups
- Filters per Filter Group: 6 filters per filter group
- Total Filters: 18 total filters across filter groups
We are still doubling the existing limits with this new proposal while ensuring a bit more safety.
What’s Changing?
- Filter Groups: The maximum number of filter groups remains increased to five.
- Total Filters: You can now define up to eighteen filters in a single search query instead of the previously announced twenty-five.
- Filters per Filter Group: Up to six filters can now be specified within each filter group, a reduction from the previously announced ten.
Reference
For further details on the initial announcement, please refer to the existing changelog, which details the original enhancements and their impact on HubSpot’s Search API.
Reminder: HubSpot CLI requires Node v18+. If using the GitHub deploy action, update to v1.7
This is a reminder about the already announced CLI Node version requirement change. If you use the GitHub deploy action you'll want to update before Sep 10, 2024, to ensure your deploys continue to work.
Module Placeholder for Programmable Email
If a Marketing Email template or module contains custom code with unresolved HubL, a placeholder module will be displayed in its place, allowing users to create the rest of their email around it. The module is a placeholder only, and will not be visible after you preview your Marketing Email as a particular contact record, or when you send the email. You can preview what the module will look like using the in-editor preview, and previewing as a specific contact. Additionally you can test how your module will look by selecting a contact record when sending the test email.
HubDB Rich Text columns now have a source code button
Source code access in rich text allows customers to write custom HTML, or modify the HTML the rich text editor creates. This way, if the default rich text editing options do not meet your needs, or small tweaks need to be made to accomplish specific things, you have access to do this via raw HTML. This functionality is slowly rolling out to all accounts that have HubDB access.
New Calls to action (CTA) API
Introducing the new API for HubSpot CTAs! Use the CTA API to control your embedded and pop-up assets and provide a more tailored experience to your visitors. CTAs are supported in Single Page Applications (SPAs) when loaded through this API.
For a complete overview, see the documentation.
Honorable mention: Preview your theme locally using the CLI
This feature has been in the CLI for a little while but was not previously announced in the changelog. In your terminal navigate to your theme folder and run hs theme preview YourThemeFolderName
in the CLI. The hs theme preview
command provides the illusion of locally rendering your site pages with your development assets by uploading them to a file buffer and then proxying your page visits with calls to the renderer to generate those pages using your buffered changes. This lets you see how changes would affect your site without ever touching the assets in your live production portal.
New Customer Feedback tab now available in App Marketplace Dashboard
A new Customer Feedback tab is now available on the App Marketplace app success dashboard, including the following sections:
- Ratings & Reviews: Displays the overall app rating, individual reviews, and the ability to reply to those reviews.
- Uninstall Survey Responses: Displays app uninstall reasons by percentage breakdown, including individual uninstall survey responses.
- Private Feedback: Displayed a table of all user-provided private feedback.
Updated list of available “Objects” in shared data section within app listing flow
For partners with apps listed on the App Marketplace, you now have access to more objects. These new and updated objects are available via the dropdown menu in the shared data section of the listing flow, and include the following values.
Campaigns | Commerce Payments | Custom Objects | Discounts |
Fees | Feedback Submissions | Goal Targets | Leads |
Line Items | Partner Accounts | Partner Clients | Postal Mail |
Quotes | Subscriptions | Taxes | Users |
Secrets in the CLI can now be up to 3000 characters in length
Developers can now upload secrets that are up to 3000 chars in length using hs secrets
add
command in the CLI.
Membership Templates now accepted in submissions within the Template Marketplace
Template providers can now submit their themes to the marketplace with membership templates included.
Themes that are marketed as membership themes, where the membership templates are necessary to properly use the theme, will need to include the following in their overview on the listing page:
"This theme requires the use of membership templates that are only available in Content Hub Professional and above".
Public Betas
CMS React Data Fetching
Currently, when you want to use CMS React in a custom module to fetch data server-side to display at render, your only option is to use GraphQL. While GraphQL is our recommended and most efficient method of fetching data from HubSpot, it is still limited in the data types that it supports. As a stopgap, we ask you to go through the mental gymnastics of passing data from a HubL template to a React component via the js_partial or module HubL tags. This forces you to still use HubL at the core of the CMS React stack, the module or partial - which makes the experience inefficient and centered around HubL (which is not your chosen development framework). As we expand the types of data supported by GraphQL, we're adding an open and adaptable way for you to query new HubSpot APIs and external APIs from within modules and partials. For a detailed walkthrough on utilizing these new capabilities, please refer to our YouTube video tutorial.
UIE Beta Updates
This month, the latest public beta for UIE extensions has added two new components and a new extension. Please see below for more information.
StatusTag Component
We are thrilled to announce the public beta release of a new UI component called StatusTag. This component is designed to improve user experience by offering clear visual indicators of process status. Status tags can be static or clickable to trigger functions through the onClick prop. It's an essential tool for highlighting interface areas that require user attention and ensuring that end users are promptly informed about status updates.
This component offers more ways to visually indicate statuses and notifications, improving user interface and experience.
Introducing: Overlays for better pop-up management
An overlay is a customizable UI component at the top of the HubSpot page. It can be either a Panel or a Modal.
Overlays can now be opened by adding the new overlay prop to components, eliminating the need for specific functions.
Users can close overlays using the new closeOverlay action function, allowing more flexibility without explicit user input.
What You Need to Change:
If you've used the Panel component, no design changes are needed. The Panel primitives remain the same.
Reactions will no longer be supported.
Note: Older reactions-based panels have yet to be deprecated but will be phased out. We recommend transitioning to the new Panels component API.
This new overlay method provides a more efficient and streamlined way to manage popups in UI Extensions. These overlays handle situations such as adding a note through the CrmActionButton more effectively. To get started, please refer to the overlay example, which demonstrates how to close and launch Modal and Panel components from an extension. Here’s a step-by-step video walkthrough as well.
App Cards (UI Extensions) for Help Desk Ticket SidebarsPrivate app developers can now create UI extensions for help desk workspace ticket sidebars, allowing for custom integrations or functionalities. This enhances the productivity of support teams by providing relevant information and enabling actions directly within the sidebar, reducing the need to navigate between different screens.
The new extension can be configured to display on Helpdesk ticket sidebars for the following pages:
- From Ticket List Page: Click "preview" when hovering over a ticket to view the sidebar.
- From Specific Ticket View: Use the "more information" button in the upper right corner to expand or collapse the sidebar.
Private app developers can set the location as helpdesk.sidebar to offer UI extensions for help desk ticket sidebars. Admins can then add these cards to the necessary views using help desk customization settings.
For detailed guidance, refer to the documentation.
If you have any inquiries or concerns, please contact us via the Developer Slack channel, #crm-customization-beta.
Questions or comments about these updates? Discuss these updates on our developer community forums.