HubL standard tags
This page is a comprehensive reference guide of the syntax and the available parameters for all standard HubL tags, including tags for system pages, such as the email subscription page. Each tag below contains a sample of the basic syntax, as well as an example with parameters and code output.
If you're building drag and drop areas, learn more about drag and drop area tags. If you maintain an older website, you may also want to check out the list of deprecated HubL tags.
Most of the tags in this page have default module equivalents. Modules can be used within dnd_areas and flexible columns, making them more powerful and user friendly than the tags you see here.
A blog comments tag renders the comments embed code on a blog template. This Javascript embed code loads the comments form and comments, based upon your configuration in your website settings.
| Parameter | Type | Description | Default |
|---|---|---|---|
limit
| Number | Sets maximum number of comments. |
5000
|
select_blog
| "default" or blog ID | Specifies which blog is connected to the comments embed. This parameter accepts arguments of either |
default
|
skip_css
| Boolean | Setting this option to True will stop the blog comments CSS from loading. |
false
|
message
| String | The message to display when there are no comments. By default, appears as empty (no text displayed). |
""
|
While drag and drop layouts include a blog content module, these modules are not created with a single tag. They instead use conditional logic to define how a blog post and a blog listing should render. You can learn more about coding blog templates here.
Creates a linked listing of posts by topic, posts by month, or posts by author.
Please note: this module can only be used in blog post templates.
| Parameter | Type | Description | Default |
|---|---|---|---|
select_blog
| "default" or blog ID | Selects the HubSpot blog to use. This parameter uses either an blog ID or "default" value. |
"default"
|
expand_link_text
| String | Text link to display if more posts than max_links number available. Exclude parameter to omit link. |
"see all"
|
list_title
| String | List title to display. |
""
|
list_tag
| String | Sets the tag used for the list. Value should generally be |
"ul"
|
title_tag
| String | Sets the tag used for the list title. |
"h3"
|
max_links
| Number | Maximum number of filter values to display. Excude parameter to show all. |
5
|
filter_type
| Enumeration | Selects the type of filter. Possible values include |
"topic"
|
Adds a listing of most popular or top posts.
Please note: this tag can only be used in blog post templates. The tag's content is loaded asynchronously on the client-side. As a result, if you want to manipulate the feed after it's loaded, you'll need to define a global JS function to handle that manipulation. Use the function hsPostListingComplete(feeds), where feeds is the jQuery selector on all feeds that have been completed. You will want to directly manipulate the DOM object in that function.
| Parameter | Type | Description | Default |
|---|---|---|---|
select_blog
| "default" or blog ID | Selects the HubSpot blog to use for the listing. This parameter uses either an blog ID or |
"default"
|
list_title
| String | List title to display. |
""
|
list_tag
| String | Sets the tag used for the list. Value should generally be |
"ul"
|
title_tag
| String | Sets the tag used for the list title. |
"h3"
|
listing_type
| String | List the blog posts by most recent or most popular in a time range. Possible values include recent, popular_all_time, popular_past_year, popular_past_six_months, and popular_past_month. |
"recent"
|
max_links
| Number | Maximum number of blog posts to list. |
5
|
include_featured_image
| Boolean | Display featured image along with post link. |
False
|
Adds a listing of blog posts based off of a set of parameters shared by posts across blogs. Posts are selected based off of their relevance to the set parameters.
This tag does not generate a page/post-level editable module, it is entirely configured with HubL.
| Parameter | Type | Description | Default |
|---|---|---|---|
blog_ids
| Number | The IDs of the blogs to include posts from. If not specified, it will include posts from the default blog. | |
blog_post_ids
| String | The IDs of the blog posts to use when finding relevant blog posts to list, separated by commas. Use this parameter only when the widget is appearing on pages. When used on blog posts, it will look for relevant posts based on the currently displaying blog post. | |
blog_post_override
| String | The IDs of the blog posts which should always show up in the returned listing, despite all other parameter values and filters (comma separated). | |
limit
| Number | The maximum number of blog posts to list. |
3
|
tags
| String | The blog tags that should be used to determine if a post is relevant (comma separated). Blog posts with the specified tags will rank higher for relevancy. | |
tag_boost
| Number | Increases the weight given to the tags specified in the | |
start_date
| datetime | Earliest published date. See an example below. | |
end_date
| datetime | Latest published date. See an example below. | |
blog_authors
| String | The names of authors to include posts from (comma separated). See an example below. | |
path_prefixes
| String | URL paths or subdirectories to include posts from (comma separated). If a blog post has a similar prefix in its path, the post’s relevancy is increased, improving its ranking in the listing. | |
callback
| String | The name of a JavaScript function to render returned blog posts. The function is passed an array of blog post objects to format. If neither the See an example below. |
none
|
post_formatter
| String | The name of a custom macro to render returned blog posts. The macro is passed three parameters which are the blogs blog post object to format, the count in the iteration of blog posts, and the total count of blog posts in the results. If not specified or set to |
default
|
allow_any_language
| Boolean | When set to |
False
|
We strongly recommend using the callback parameter instead of post_formatter to improve page loading speed.
The following example generates a listing of posts written by one of the three specified blog_authors across two different blogs:
{% related_blog_posts blog_ids="3241539189,3261083894", limit=6, blog_authors="John Smith,Joe Smith,Frank Smith" %}The following example generates a listing of 10 posts related to a specific blog post, with the blog tag "sales enablement," and restricted to a specific publish date time frame. This example specifies the blog_post_ids parameter, so it would be used on a page:
{% related_blog_posts blog_post_ids="3267910554", limit=10, tags="sales enablement", start_date="2018-02-05", end_date="2018-06-10" %}The following example generates a listing of five posts using the callback parameter to control the HTML output of the post listing:
{% related_blog_posts limit=5, callback="blog_post_formatter" %}
<script>
var blog_post_formatter = function(blogposts) {
var formatted = "<div>";
for (var i = 0; i < blogposts.length; i++) {
var blogpost = blogposts[i];
formatted += '<div class="related-blog-item">';
formatted += `<span>Related Post ${i + 1}/${blogposts.length}</span><br>`;
formatted += `<a class="related-blog-title" href="${blogpost.url}"><span>${blogpost.name}</span></a>`;
formatted += `<div class="hs-related-blog-byline">by <span class="related-blog-author">${blogpost.blogAuthor.fullName}</span><span class="related-blog-posted-at"> posted on </span><span class="related-blog-date">${new Date(blogpost.publishDate).toLocaleDateString()}</span></div>`;
formatted += `<p class="related-blog-post-summary">${blogpost.postSummary}<a href="${blogpost.url}">Read more</a></p>`;
formatted += '<div class="related-blog-tags">';
if (blogpost.tagList.length > 0) {
formatted += `Tags: ${blogpost.tagList.map(tag => tag.label).join(", ")}`;
}
formatted += '</div>';
if (blogpost.featuredImage) {
formatted += `<img src="${blogpost.featuredImage}" alt="${blogpost.featuredImageAltText}">`;
}
formatted += '</div>';
}
formatted += '</div>';
return formatted;
}
</script>Blog social sharing renders share counters on your blog posts (if enabled in Content Settings).
| Parameter | Type | Description | Default |
|---|---|---|---|
select_blog
| "default" or blog ID | Species which blog is connected to the share counters. This parameter accepts arguments of either |
default
|
downgrade_shared_url
| Boolean | Use HTTP in the url sent to the social media networks. Used to preserve counts when upgrading domains to HTTPS only. |
false
|
A blog subscription tag renders the blog subscriber form for a particular blog. This form is automatically created whenever a blog is created in Content Settings, and there is always one subscription form per blog. Please note that the subscribe form's fields are configured within the Forms editor UI.
| Parameter | Type | Description | Default |
|---|---|---|---|
select_blog
| "default" or blog ID | Selects which blog subscription form to render. This parameter accepts arguments of either |
default
|
title
| String | Defines text in an h3 tag title above the subscribe form. |
"Subscribe Here!"
|
no_title
| Boolean | If True, the h3 tag above the title is removed. |
false
|
response_message
| String | Defines the inline thank-you message that is rendered when a user submits a form. Supports HTML. |
"Thanks for Subscribing!"
|
edit_form_link
| String | This parameter generates a link that allows users to click through to the corresponding Form editor screen. This option will only show in the editor UI if the modules has the parameter overrideable=True. For example, to replace HubID and form ID with the information from the URL of your default blog subscriber form: \n drops the code onto a new line. |
A boolean tag creates a checkbox in the UI that prints "true" or "false." In addition to printing the value, this module is useful for defining conditional template logic, when combined with the parameter export_to_template_context.
| Parameter | Type | Description | Default |
|---|---|---|---|
value
| Boolean | Determines whether the checkbox is checked or unchecked. |
False
|
A choice tag creates a dropdown in the content editor UI that prints the value selected by the user. Choice tags are great for giving your users a preset set of options, such as printing the type of page as a page header.
In addition to printing the choice value, this tag is useful for defining conditional template logic, when combined with the parameter export_to_template_context.
| Parameter | Type | Description |
|---|---|---|
value
| Boolean | The default field value for the dropdown |
choices
| Sequence | A comma-separated list of values, or list of value-label pairs. The syntax for value label pairs is as follows: |
The color tag generates a color picker in the page editor UI that prints a HEX color value to a template. Please note that this module can only be used in templates, not CSS files. If using this tag in a <style> or inline CSS, you will want to use the no_wrapper=True parameter to remove the wrapper <span> wrapper.
| Parameter | Type | Description |
|---|---|---|
color
| String | A default HEX color value for the color picker |
A Call to Action or CTA tag allows users to add a HubSpot Call to Action button to a predefined area of a page.
| Parameter | Type | Description |
|---|---|---|
embed_code
| String | The embed code for the CTA. \n differentiates line breaks. |
full_html
| String | The embed code for the CTA (Same as embed_code). \n differentiates line breaks. |
image_src
| String | Image src url that defines the preview image in the content editor. |
image_editor
| String | Markup for the image editor preview |
guid
| String | The unique ID number of the CTA. This ID number is available in the URL of the Details screen of a particular CTA. This parameter is used to choose which CTA to display by default. |
image_html
| String | CTA image HTML without the CTA script.* |
image_email
| String | Email-friendly version of the CTA code.* |
*While these parameters are included here for the sake of being comprehensive, the code generated by HubSpot to populate them is very specific. If you need a default CTA selected, rather than trying to develop the CTA parameters from scratch, it is recommended that set up the CTA on a template layout, and then clone to file. You can then copy the HubL CTA module of the CTA with all parameters set correctly for you.
There is also a CTA function that generates a CTA from the ID.
A custom HTML module allows users to enter raw HTML into the content editor. If you need to add extensive default HTML to the tag, you may want to use block syntax.
| Parameter | Type | Description |
|---|---|---|
value
| String | Sets the default content HTML of the module. |
Custom Modules allow HubSpot designers to create a custom group of editable content objects to be used across templates and pages on HubSpot’s CMS, while still allowing marketers to control the specific content appearing within those modules on a page-by-page basis. You can learn more about custom modules and their simplified HubL syntax, here.
Custom modules must be built in the Custom Module editor, but they can be included into coded templates and HubL modules. You will see a 'Usage Snippet' in the right sidebar of the Custom Module editor under 'Template Usage'.
Custom modules require the ID of the module as a string as well as a path parameter in order to specify which module to load. The usage snippet will also include a label parameter. See the syntax below:
| Parameter | Type | Description |
|---|---|---|
module_id
| String | The id of the module to render. |
path
| String | The path of the module to render. Include leading slash for absolute path, otherwise path is relative to template. Reference HubSpot default modules with paths corresponding to their HubL tags such as @hubspot/rich_text, @hubspot/linked_image, etc. |
When building a module, you can add either default content to your fields or an editor_placeholder HubL tag to the HTML + HubL file to render placeholder content. This tag renders the module's icon and name as empty placeholders in the editor.
This tag can be useful when the module doesn't have or need default content, or to streamline module building.
To add a placeholder to a custom module, you can add an if statement to the HTML + HubL file to render the placeholder when there's no content selected. For example:
While you cannot edit the placeholder's styling, you can add the following properties to the module's meta.json file to customize its content:
| Parameter | Type | Description |
|---|---|---|
show_module_icon
| Boolean | Whether to display the module's icon. |
title
| String | The title that appears in the placeholder. |
description
| String | The description that appears in the placeholder. |
For example, your meta.json file might look like the following:
Flexible columns are vertical columns in a template that enable content creators to insert and remove modules to the page using the content editor. When coding a flexible column with HubL, you can choose to wrap other HubL modules to make them appear in the flexible column by default. The sample code below shows the basic syntax and a sample flexible column with a rich text and form module contained as default content.
Please note that flexible columns can only be added to page templates, not blog or email templates. Modules cannot contain flexible columns, but they can instead contain repeatable fields and groups, which provide a similar functionality.
Please note: when using this tag, the label must follow the name value for the flexible column to function in the content editor. For example, the following syntax is invalid:
[% widget_container label="My label" "my_flexible_column" %}
Allows users to select a HubSpot form to add to their page.
| Parameter | Type | Description | Default |
|---|---|---|---|
form_key
| String | Specifies a unique id for the form at the page level. | |
form_to_use
| String | Specifies which form to load by default, based on the Form ID. This ID is available in the form editor URL of a each form. | |
title
| String | Populates an h3 header tag above the form. | |
no_title
| Boolean | If |
False
|
form_follow_ups_follow_up_type
| Enumeration | Specifies follow up actions such as enrolling a contact into a workflow or sending a simple follow up email. Possible values include: | |
simple_email_for_live_id
| Number | Specifies the ID of the simple follow-up email for the live page. | |
simple_email_for_buffer_id
| Number | Specifies the ID of the simple follow-up email for the auto-save version of a page. | |
follow_up_type_simple
| Boolean | If true, enables a simple follow-up email. Alternative to | |
follow_up_type_automation
| Boolean | If true, enrolls submissions in a workflow. Alternative to | |
simple_email_campaign_id
| Number | Specifies the ID of the simple follow-up email. Alternative to | |
form_follow_ups_workflow_id
| Number | Specifies the ID of the workflow in which to enroll submissions. | |
response_redirect_url
| String | If redirecting to an external page, this parameter specifies the URL to redirect to. | |
response_redirect_id
| Number | If redirecting to HubSpot hosted page, this parameter specifies the page ID of that page. The page ID is available in the page editor URL of each page. | |
response_response_type
| Enumeration | Determines whether to redirect to another page or to display an inline thank you message on submission. The value of this parameter should either be |
inline
|
response_message
| String | Sets an inline thank you message. This parameter supports HTML. | |
notifications_are_overridden
| Boolean | If True, the form will send form notifications to specified email addresses selected in the |
False
|
notifications_override_guid_buffer
| String | ID of override settings in auto-save version of page. | |
notifications_override_guid
| String | ID of override settings in live version of page. | |
notifications_override_email_addresses
| JSON | Block syntax supports a JSON list of email recipients that will be notified upon form submission. These email addresses will override the email notification settings set in the form. | |
gotowebinar_webinar_key
| String | Specifies the GoToWebinar webinar to enroll contacts who submit the form into. Only available for portals using the GoToWebinar integration. | |
sfdc_campaign
| String | Specifies the Salesforce campaign to enroll contacts who submit the form into. This parameter's value should be the SFDC campaign ID and is only available for portals that are integrated with Salesforce. |
Renders copyright information with the year and company name specified in Content Settings (Email > Footer Information).
Generates a HubSpot gallery tag. This gallery tag is based on Slick. While you can create a gallery module with standard module HubL syntax, If you want to predefine default slides using HubL, you must use block syntax. Both methods are shown below. Gallery images are lazy loaded using JavaScript.
| Parameter | Type | Description | Default |
|---|---|---|---|
slides
| JSON | A JSON list of the default caption, the link url, the alt text, the image src, and whether to open in a new tab. See block syntax above. | |
loop_slides
| Boolean | When True, continuously loop through slides. |
True
|
num_seconds
| Number | Time in seconds to pause between slides. |
5
|
show_pagination
| Boolean | Provide buttons below slider to navigate among slides. |
True
|
sizing
| Enumeration | Determines whether the slider changes sizes, based on the height of the slides. Possible values include: "static" or "resize". |
"static"
|
auto_advance
| Boolean | Automatically advance slides after the time set in num_seconds. |
False
|
transition
| Enumeration | Sets the type of slide transition. Possible values include: "fade" or "slide". |
"slide"
|
caption_position
| Enumeration | Affects positioning of caption on or below the slide. Possible values include "below" or "superimpose". |
"below"
|
display_mode
| Enumeration | Determines how the image gallery will be displayed. Possible values include: "standard", "lightbox", "thumbnail". |
"standard"
|
lightboxRows
| Number | If "display_mode" is set to "lightbox", this parameter will control the number of rows displayed within the lightbox. |
3
|
Generates a header module that will render text as an h1-h6 tag.
| Parameter | Type | Description | Default |
|---|---|---|---|
header_tag
| String | Select which heading tag to render. Possible values include: h1, h2, h3, h4, h5, h6. |
h1
|
value
| String | Renders default text within the heading module. |
"A clear bold header"
|
| Parameter | Type | Description | Default |
|---|---|---|---|
name
| String | Name of the icon. | |
style
| String | Style of the icon. Possible values: |
REGULAR
|
unicode
| String | The Unicode character representation of the icon. | |
icon_set
| String | The FontAwesome icon set to use. Possible values are:
| |
purpose
| String | The purpose of the icon, used for accessibility. Possible values are |
decorative
|
title
| String | The title element of the icon's svg, along with a |
Creates a image tag that allows users to select an image from the content editor. If you want the image to be linked to a destination URL, you should use linked_image below.
| Parameter | Type | Description | Default |
|---|---|---|---|
alt
| String | Sets the default alt text for the image. | |
src
| String | Populates the src attribute of the img tag. | |
width
| Number | Sets the width attribute of the img tag. |
The width of the image
|
height
| Number | Sets a min-height in a style attribute of the img tag for email templates only. |
The height of the image
|
hspace
| Number | Sets the hspace attribute of the img tag. | |
align
| String | Sets the align attribute of the img tag. Possible values include: left, right, & center. | |
style
| String | Adds inline CSS declarations to the img tag. For example style="border:1px solid blue; margin:10px" | |
loading
| String | Controls img element loading attribute. Used for browser based lazy loading. |
An image src module creates a image selector in the content editor, but rather than printing a img tag, it renders the URL of the image. This tag is generally used with no_wrapper=True parameter, so that the image src can be added to inline CSS or other markup. An alternative to using this tag is to use the export_to_template_context parameter.
| Parameter | Type | Description | Default |
|---|---|---|---|
src
| String | Specifies the default URL image src. |
Adds a Globe Icon with links to the translated versions of a given CMS page. Learn more about multi-language content here.
| Parameter | Type | Description | Default |
|---|---|---|---|
display_mode
| Enumeration | The language of the text in the language switcher. Values are:
|
Localized
|
Creates a user-selectable image that is wrapped in a link. This module has all of the parameters of an image module with two additional parameters that specify the link destination URL and whether the link opens in a new window.
| Parameter | Type | Description | Default |
|---|---|---|---|
alt
| String | Sets the default alt text for the image. | |
src
| String | Populates the src attribute of the img tag. | |
width
| Number | Sets the width attribute of the img tag. |
The width of the image
|
height
| Number | Sets a min-height in a style attribute of the img tag for email templates only. |
The height of the image
|
hspace
| Number | Sets the hspace attribute of the img tag. | |
align
| String | Sets the align attribute of the img tag. Possible values include: left, right, & center. | |
style
| String | Adds inline CSS declarations to the img tag. For example style="border:1px solid blue; margin:10px" | |
open_in_new_tab
| Boolean | Selects whether or not to open the destination URL in another tab. |
False
|
link
| String | Sets the destination URL of the link that wraps the img tag. | |
target
| String | Sets the target attribute of the link tag. | |
loading
| String | Controls img element loading attribute. Used for browser based lazy loading. |
A logo module renders your company's logo image from Content Settings.
| Parameter | Type | Description | Default |
|---|---|---|---|
suppress_company_name
| Boolean | Hides company name if an image logo isn't set. |
False
|
alt
| String | Sets the default alt text for the image. |
Value in Content Settings
|
src
| String | Populates the src attribute of the img tag. |
Value in Content Settings
|
width
| Number | Sets the width attribute of the img tag. |
The width of the image
|
height
| Number | Sets a min-height in a style attribute of the img tag for email templates only. |
The height of the image
|
hspace
| Number | Sets the hspace attribute of the img tag. | |
align
| String | Sets the align attribute of the img tag. Possible values include: left, right, & center. | |
style
| String | Adds inline CSS declarations to the img tag. For example style="border:1px solid blue; margin:10px" | |
open_in_new_tab
| Boolean | Selects whether or not to open the destination URL in another tab. |
False
|
link
| String | Sets the destination URL of the link that wraps the img tag. | |
override_inherited_src
| Boolean | If true, use src from logo widget rather than src inherited from settings or template. |
True
|
heading_level
| String | When using non-linked text-based logos, this wraps the text-based logo in one of the following available options as an HTML tag: |
h1
|
loading
| String | Controls img element loading attribute. Used for browser based lazy loading. |
Generates an advanced menu based on a menu tree in Content Settings > Advanced Menus. See menus and navigation for more information on using menus in templates and modules. If id is set to null the menu tag will render the default menu for the HubSpot account.
| Parameter | Type | Description | Default |
|---|---|---|---|
id
| Number | ID of Menu Tree from Advanced Menus in Content Settings. | |
site_map_name
| String | Name of Menu Tree from Advanced Menus in Content Settings. |
"default"
|
root_type
| Enumeration | Specifies the type of advanced menus. Options include: "site_root", "top_parent", "parent", "page_name", "page_id", and "breadcrumb". These values correspond to static, dynamic by section, dynamic by page, and breadcrumb. |
"site_root"
|
flyouts
| String | When true, a class is added to the menu tree that can be styled to allow child menu items will appear when you hover over the parent. When false, child menu items will always appear. |
"true"
|
max_levels
| Number | Determines how many levels of nested menus render in the markup. This parameter dictates number of menu tree children that can be expanded in the menu. |
2
|
flow
| Enumeration | Sets orientation of menu items. This adds classes to menu tree, so that they can be styled accordingly. Possible values include "horizontal", "vertical" or "vertical_flyouts". Horizontal menus display items side-by-side, and vertical menus are top-to-bottom. |
"horizontal"
|
root_key
| String | Used to find the menu root. When root_type is set to page_id or page_name, this param should be the page ID or the label of the page, respectively. |
"horizontal"
|
label
| String | Some rich content to describe this entity |
False
|
label
| String | Some rich content to describe this entity |
False
|
A HubL tag that enqueues a style element to be rendered in the <head>.
This tag is similar to the require_css function, except that this tag inserts styling inline rather than from a stylesheet. This tag also does not deduplicate against other instances of the CSS on the same page. If you're building a module and want to insert a stylesheet, but you might use that module multiple times on a single page, you may want to use the require_css function instead.
A HubL tag that enqueues anything placed inside of it into the standard_header_includes which is in the template's <head>. For most Javascript and CSS see require_js and require_css. Some use-cases for require_head include supplying meta tags, and special link tags (like prefetch and preconnect) from modules.
A HubL tag that enqueues a script element to be rendered. To enqueue a script to render in the <head />from a different file via a <script /> element (as opposed to inline as shown here), use the HubL function require_js(absolute_url) instead.
| Parameter | Type | Description | Default |
|---|---|---|---|
position
| String | Set the position where the inline script will be rendered. Options include: |
"footer"
|
Creates a WYSIWYG content editor.
| Parameter | Type | Description | Default |
|---|---|---|---|
html
| String | Default rich text content for module. |
<h2>Something Powerful</h2> <h3>Tell The Reader More</h3> <p>The headline and subheader tells us what you're offering, and the form header closes the deal. Over here you can explain why your offer is so great it's worth filling out a form for.</p> <p>Remember:</p> <ul> <li>Bullets are great</li> <li>For spelling out <a href="#">benefits</a> and</li> <li>Turning visitors into leads.</li> </ul>
|
hsRssFeedComplete(feeds), where feeds is the jQuery selector on all feeds that have been completed. You can directly manipulate the DOM object in that function.
| Parameter | Type | Description | Default |
|---|---|---|---|
show_title
| Boolean | Shows or hides RSS feed title. |
True
|
show_date
| Boolean | Displays post date. |
True
|
show_author
| Boolean | Displays author name. |
True
|
show_detail
| Boolean | Display post summary up to number of characters set by |
True
|
title
| String | Populates a heading above the RSS feed listing. | |
limit_to_chars
| Number | Maximum number of characters to display in summary. |
200
|
publish_date_format
| String | Format for the publish date. Possible values include |
"short"
|
attribution_text
| String | The text which attributes an author to a post. |
"by"
|
click_through_text
| String | The text which will be displayed for the click through link at the end of a post summary. |
"Read more"
|
publish_date_text
| String | The text which indicates when a post was published. |
"posted at"
|
include_featured_image
| Boolean | Displays featured image with post link for HubSpot generated RSS feeds. |
False
|
item_title_tag
| String | Specifies HTML tag of each post title. |
span
|
is_external
| Boolean | RSS feed is from an external blog. |
False
|
number_of_items
| Number | Maximum number of posts to display. |
5
|
publish_date_language
| String | Specifies the language of the publish date. |
en_US
|
rss_url
| String | The URL where the RSS feed is located. | |
content_group_id
| String | ID for blog when feed source is internal blog. | |
select_blog
| String | Can be used to select an internal HubSpot blog feed. |
default
|
feed_source
| String | Set source for RSS feed. When internal, general format is | |
tag_id
| Number | ID for tag when feed source is internal blog. |
Generates an html heading and <p> subheader.
| Parameter | Type | Description | Default |
|---|---|---|---|
header
| String | Text to display in header. |
"A clear and bold header"
|
subheader
| String | Text to display in subheader. |
"A more subdued subheader"
|
heading_level
| String | The semantic HTML heading level. h1 to h6 are supported. |
"h1"
|
Simple menus allow you to create basic navigation menus that can be modified at the page level. Unlike regular menu modules, simple menus are not managed from the Navigation screen in Website Settings, but rather from the template and page editors. You can use block syntax to set up a default menu tree.
| Parameter | Type | Description | Default |
|---|---|---|---|
orientation
| Enumeration | Defines classes of menu markup to allow to style the orientation of menu items on the page. Possible values include |
"horizontal"
|
menu_tree
| JSON | Menu structure including page link names and target URLs. |
[]
|
Social sharing tags generate social media icons that can be used to share a particular page. This module can be used with block syntax to customize the icon images and more.
| Parameter | Type | Description | Default |
|---|---|---|---|
use_page_url
| Boolean | If true, the module shares the URL of the page by default. |
True
|
link
| String | Specifies a different URL to share, if | |
pinterest
| JSON | Parameters for Pinterest link format and icon image source. |
See block syntax example, above
|
twitter
| JSON | Parameters for Twitter link format and icon image source. |
See block syntax example, above
|
linked_in
| JSON | Parameters for LinkedIn link format and icon image source. |
See block syntax example, above
|
facebook
| JSON | Parameters for Facebook link format and icon image source. |
See block syntax example, above
|
email
| JSON | Parameters for email sharing link format and icon image source. |
See block syntax example, above
|
A spacer tag generates an empty span tag. This tag can be styled to act as a spacer. In drag and drop layouts, the spacer module is wrapped in a container with a class of span1-span12 to determine how much space the module should take up in the twelve column responsive grid.
The following tags can be used on system pages, such as the password reset or email subscription pages.
The backup unsubscribe tag renders for email recipients, if HubSpot is unable to determine their email address, when that recipient tries to unsubscribe. This tag renders a form for the contact to enter his or her email address to unsubscribe from email communications. It should be used on an Unsubscribe Backup system template.
| Parameter | Type | Description | Default |
|---|---|---|---|
header
| String | Renders text in an h1 tag above the unsubscribe form. |
"Email Unsubscribe"
|
input_help_text
| String | Renders help text in an h3 tag above your email unsubscribe form field. |
"Your email address:"
|
input_placeholder
| String | Adds placeholder text within the email address form field. |
"email@example.com"
|
button_text
| String | Changes the text of the unsubscribe form submit button. |
"Unsubscribe"
|
This module renders when an email recipient goes to edit his or her subscription preferences. It should be used on a Subscription Preference system template.
| Parameter | Type | Description | Default |
|---|---|---|---|
header
| String | Renders text in an h1 tag above the subscription preferences form. |
"Communication Preferences"
|
subheader_text
| String | Populates text below the heading above the unsubscribe preferences. |
"<p>\n If this is not your email address, please ignore this page since the email associated with this page was most likely forwarded to you.\n</p>"
|
unsubscribe_single_text
| String | Renders text in a <p class="header"> above the subscription options. |
"Uncheck the types of emails you do not want to receive:"
|
unsubscribe_all_text
| String | Renders text in a <p class="header"> above the unsubscribe from all emails checkbox input. |
"Or check here to never receive any emails:"
|
unsubscribe_all_unsubbed_text
| String | Populates text within a <p> that renders, if a contact is currently unsubscribed from all emails. |
"You are presently unsubscribed from all of our emails. Would you like to receive our emails again?"
|
unsubscribe_all_option
| String | Sets the text next to the unsubscribe from all emails checkbox input. |
"Unsubscribe me from all mailing lists."
|
button_text
| String | Sets the text of the submit button that updates subscription preferences. |
"Update email preferences"
|
resubscribe_button_text
| String | Sets the text of the submit button for when contacts are resubscribing. |
"Yes, resubscribe me!"
|
The email subscriptions update confirmation is a module that can be added to the thank you template for when a recipient updates his or her subscription preferences or unsubscribes. It should be used on a Subscription Preference system template.
| Parameter | Type | Description | Default |
|---|---|---|---|
header
| String | Renders text in an h1 tag above the unsubscribe form. |
"Communication Preferences"
|
subheader_text
| String | Populates text above the confirmation message. |
"<p>\n If this is not your email address, please ignore this page since the email associated with this page was most likely forwarded to you.\n</p>"
|
unsubscribe_all_success
| String | Sets the text that will display when someone unsubscribes from all email communications. |
"You have successfully unsubscribed from all email communications."
|
subscription_update_success
| String | Sets the text when a recipient updates his or her subscription preferences. |
"You have successfully updated your email preferences."
|
Creates a login form to provide access to private content.
| Parameter | Type | Description | Default |
|---|---|---|---|
email_label
| String | The label for the email entry field. |
"Email"
|
password_label
| String | The label for the password entry field. |
"Password"
|
remember_me_label
| String | The label for the "Remember Me" checkbox. |
"Remember Me"
|
reset_password_text
| String | The text for the password reset hyperlink. |
"Forgot your password?"
|
submit_button_text
| String | The text for the submit button. |
"Login"
|
show_password
| String | The text for the password reveal link. |
"Show password"
|
Creates a form to register for access to private content.
| Parameter | Type | Description | Default |
|---|---|---|---|
email_label
| String | The label for the email entry field. |
"Email"
|
password_label
| String | The label for the password entry field. |
"Password"
|
password_confirm_label
| String | The label for the password confirmation field. |
"Confirm Password"
|
submit_button_text
| String | The text for the submit button. |
"Save Password"
|
show_password
| String | The text for the password reveal link. |
"Show password"
|
Creates a form to send a password reset email for accessing password-protected pages.
| Parameter | Type | Description | Default |
|---|---|---|---|
email_label
| String | The label for the email entry field. |
"Email"
|
submit_button_text
| String | The text for the submit button. |
"Send Reset Email"
|
password_reset_message
| String | The message that displays after requesting the password reset email. |
False
|
Renders a password reset form for accessing password-protected pages.
| Parameter | Type | Description | Default |
|---|---|---|---|
password_label
| String | The text label for the password input field. |
"Email"
|
password_confirm_label
| String | The text label for the password confirmation input field. |
"Send Reset Email"
|
submit_button_text
| String | The text label for the form submit button. |
False
|
show_password
| String | The text label for the button to unhide the entered password value. |
False
|
password_requirements
| String | The text label that describes password requirements. |
False
|
Adds a password prompt to password-protected pages.
| Parameter | Type | Description | Default |
|---|---|---|---|
submit_button_text
| String | Label for button below password entry field. |
"Submit"
|
bad_password_message
| String | Message displayed if incorrect password entered. |
"<p>Sorry, please try again.</p>"
|
password_placeholder
| String | Defines placeholder text within the password field. |
"Password"
|
Creates a single line of text. This tag can be useful to be mixed into your markup, when used in conjunction with the no_wrapper=True parameter. For example, if you wanted your end users to be able to define a destination of a predefined anchor, you could populate the href with a text module with no_wrapper=True.
| Parameter | Type | Description | Default |
|---|---|---|---|
value
| String | Sets the default text of the single line text field. |
A textarea is similar to a text module in that it allows users to enter plain text, but it gives them a larger area to work in the content editor. This module does not support HTML. If you want to use directly within a predefined wrapping tag, add the no_wrapper=true parameter.
| Parameter | Type | Description | Default |
|---|---|---|---|
value
| String | Sets the default text of the textarea. |
Render a video player for a video file from the file manager that has the Allow embedding, sharing, and tracking setting turned on.
| Parameter | Type | Description | Default |
|---|---|---|---|
hide_playlist
| Boolean | Hide the video playlist. |
True
|
playlist_color
| String | A HEX color value for the playlist. | |
play_button_color
| String | A HEX color value for the play and pause buttons. |
#2A2A2A
|
embed_button
| Boolean | Display embed button on the player |
False
|
viral_sharing
| Boolean | Display the social networks sharing button on the player. |
False
|
width
| Number | Width of the embedded video player. |
Auto
|
height
| Number | Height of the embedded video player. |
Auto
|
player_id
| Number | The | |
style
| String | Additional style for player. | |
conversion_asset
| JSON | Event setting for player. Can render CTA or Form before or after video plays. This parameter takes a JSON object with three parameters: type (FORM or CTA), id (The guid of the type object), position (POST or PRE). |
See above example
|
placeholder_alt_text
| String | The video's alt text. |
Thank you for your feedback, it means a lot to us.
Social sharing