Default web modules

The blog to use for the module.

Title for the module (wrapped in a h3 tag)

The message that is shown upon submitting the form.

The content layout for each blog post preview.

• grid (default): aligns posts in a basic grid.
• singleColumn: aligns posts in a single column. with featured images on their own row above the rest of the post content.
• sideBySide: aligns posts in a column with featured images aligned horizontally with the post content.

When using the grid layout, the number of posts per row. Can be 2, 3, or 4.

When using the sideBySide layout, set to true to align the featured image on the right and left side of the post preview, alternating.

When using the grid or singleColumn layouts, set this field to true to make the featured image the background of the post preview.

The content to include in each blog post preview. Choices include:

• image: the post's featured image.
• title: the post's title.
• authorImage: the post author's image.
• authorName: the post author's name.
• tags: the post's blog tags.
• publishDate: the post's publish date.
• description: the post's meta description.
• button: the read more button that links to the blog post.

The text that displays on the read more button, if included.

Select a blog to display. Default will use the current blog when used in a blog template or the primary blog when used elsewhere.

Type of filtering links to show. Choices include:

• tag
• month
• author

Ordering for the values of filter links. Choices include:

• post_count
• name

An H3 heading.

Number of filter links to show. Leave blank to show all.

Text to display if more than the max_links value to display are available. 

Select a blog to display. Default will use the current blog when used in a blog template or the primary blog when used elsewhere.

The type of listing for your posts. Choices include:

• recent: most recent.
• popular_all_time: most popular of all time.
• popular_past_year: most popular the past year.
• popular_past_six_months: most popular the past six months.
• popular_past_month: most popular the past month.

An H3 heading. 

Maximum number of posts to display. 

The URL that the button redirects to.

Text that will be displayed on the button.

• override_default_style (Boolean)
  
• button_font (Font)
  
• button_color (Color)
  
• text_hover_color (Color)
  
• button_hover_color (Color)

Globally Unique Identifier of the CTA. 

Message displayed above the button.

Button text.

• group_success_alert:
  • content: rich text content of success alert.
• group_fail_alert:
  • content: rich text content of fail alert.
• group_close_icon:
  • icon: the icon to close the alert.

Pixel (px) height of the divider line.

Percentage (%) width of the divider line.

Color (hex) and opacity (number) of the divider line.

Line type. Choices include:

• solid
• dotted
• dashed

Horizontal alignment of divider line. Choices include:

• left
• center
• right

Show/hide top and bottom margining on the divider.

Pixel (px) value for the margining on top and bottom of divider line. 

Option available when show_padding equals true.

Message displayed above the button.

Button text.

• group_success_alert:
  • content: rich text content of success alert.
• group_fail_alert:
  • content: rich text content of fail alert.
• group_close_icon:
  • icon: the icon to close the alert.

H3 heading.

Open links in new window.

Social network selection. Options include:

• network (Choice)
• link (Link)
• network_image (Image)
• supporting_text (Text)

Display options for showing social networks. Choices include:

• icon
• icon_text
• text_only

Size of the icon (px).

Left and Right Padding (px) for items.

The alignment of the items on the page. Choice include:

• left
• center
• right

Color scheme to use for icons. Choices include:

• color
• black (black and white)
• grey
• white
• custom

Custom color to use when color_scheme equals custom.

Shape of the social icons. Choices include:

• circle
• square
• original

Font object for social network text. Available when display does not equal icon.

Font object contains: 

• size
  • value: number
  • units: unit of Measure
• color: hex value
• styles
  • bold: boolean
  • italic: boolean
  • underline: boolean
• font: text

H3 heading

Form object including:

• form_id: ID for form to use
• response_type: what the visitor will see after submitting the form:
  • inline
  • redirect
• message: inline message if response_type is set to inline
• redirect_id: ID of page to be redirected to if response_type is set to redirect.
• redirect_url: URL to be redirected to if response_type is set to redirect

Email to send form notification to instead of form defaults.

Comma-separated list of emails to send to when notifications_are_overridden equals true.

Enabled sending a follow up email.

ID of the follow-up email. Available when follow_up_type_simple equals true.

When Salesforce integration is active, the campaign ID.

Text for the heading.

Choose a heading level. Choice include h1 through h6.

The name of the icon.

An accessibility option that categorizes the purpose of the icon for screen readers. Available values are:

• decorative: ignored by the screen reader.
• semantic: read by the screen reader.

An accessibility option that assigns the icon a title.

The icon's unicode value.

Image object containing:

• src: image url
• alt: alt text for image
• loading: lazy loading options include:
  • disabled
  • lazy
• width: px value
• height: px value

Optional link for the image.

Opens link in a new tab.

Object containing information for each slide. Object contains:

• img: image URL.
• link_url: URL where the slide should link.
• hover_messages: text that overlays on the image on hover.

Display mode of the Image Gallery. Choices include:

• standard: standard slider.
• thumbnail: thumbnail navigator.
• lightbox: lightbox gallery.

Number of rows in the Lightbox gallery when display_mode equals lightbox.

Enables looping through the slides with next/prev when display_mode equals standard or thumbnail.

Automatically advances to the next slide when display_mode equals standard or thumbnail.

Amount of time (seconds) between advancing to the next slide when display_mode equals standard or thumbnail.

Show navigation buttons when  display_mode equals standard or thumbnail.

Sets the height of the slides when display_mode equals standard or thumbnail. Choices include:

• static: fixed height.
• resize: variable height.

Slide transition styles when display_mode equals standard or thumbnail. Choices include:

• slide: slide transition.
• fade: fade transition.

Position of the slide captions when display_mode equals standard or thumbnail. Choices include:

• below: always keep captions below the image.
• superimpose: superimpose captions on top of images.

Object containing information for each slide. Object contains:

• img: image URL.
• show_caption: boolean to show slide caption.
• caption: rich text for caption.
• link_url: URL where the slide should link.
• open_in_new_tab: boolean to direct if the link should open in a new tab.

Display mode of the Image Gallery. Choices include:

• standard: standard slider.
• thumbnail: thumbnail navigator.
• lightbox: lightbox gallery.

Number of rows in the Lightbox gallery when display_mode equals lightbox.

Enables looping through the slides with next/prev when display_mode equals standard or thumbnail.

Automatically advances to the next slide when display_mode equals standard or thumbnail.

Amount of time (seconds) between advancing to the next slide when display_mode equals standard or thumbnail.

Show navigation buttons when  display_mode equals standard or thumbnail.

Sets the height of the slides when display_mode equals standard or thumbnail. Choices include:

• static: fixed height.
• resize: variable height.

Slide transition styles when display_mode equals standard or thumbnail. Choices include:

• slide: slide transition.
• fade: fade transition.

Position of the slide captions when display_mode equals standard or thumbnail. Choices include:

• below: always keep captions below the image.
• superimpose: superimpose captions on top of images.

A field group containing the following fields:

• img: image URL.
• caption: rich text for image caption.
• link_url: URL that the slide links to.

The image slider settings field group. Includes the following field groups:

• slides: slide settings, including:
  • per_page: number of slides per page.
  • sizing: image sizing.
  • aspect_ratio: image aspect ratio.
  • show_captions: a boolean
• movement: image sliding behavior settings.
• navigation: image navigation settings.

The module's default text elements, including:

• default_caption: image caption.
• default_image_alt_text: image text.
• slider_aria_label: the module's default aria label.
• arial_label_thumbnails: the module's default aria thumbnail.
• slider_nav_aria_label: the module navigation's default aria label.
• prev: previous slide text.
• next: next slide text.
• first: go to first slide text.
• slideX: go to X slide text.
• pageX: go to X page text.
• play: start autoplay text.
• pause: pause autoplay text.
• carousel: carousel text.
• select: text for selecting a slide to show.
• slide: slide text.
• slidelabel: slide label.

The language of the text in the language switcher. Options include:

• pagelang: the names of languages will display in the language of the page the switcher is on.
• localized: the name of each language will display in that language.
• hybrid: a combination of the two.

Image object containing:

• override_inherited_src: override the default logo from settings
• src: image url
• alt: alt-text for logo

Optional link for the logo. If no URL is specified, your logo will link to the Logo URL set in your brand settings.

Opens link in a new tab.

Hide the company name when an image is not selected.

Choose a heading level when no image is selected and suppress_company_name equals false. Choices include h1 through h6.

Select a meeting link.

Your facebook app ID.

Enable the button for Facebook login. facebook_appid is required.

Your Google client ID.

Enable the button for Google login. google_clientid is required.

ID of the menu.

Advanced menu type. Choices include:

• site_root: always show top-level pages in menu.
• top_parent: show pages in menu that are related to section being viewed.
• parent: show pages in menu that are related to page being viewed.
• breadcrumb: breadcrumb style path menu (uses horizontal flow).

Determines the number of menu tree children that can be expanded in the menu. Choices include 1 through 10

Orientation of the menu. Choices include:

• horizontal
• vertical

Enabled hover over functionality for child menu items.

Text that appears on the submit button.

Placeholder text for the password field.

Message to show when a password is entered incorrectly. 

To set the module to use a specific payment link, include the ID of the payment link. You can find the ID in the URL while editing the payment link.  

Set whether the payment form opens in a new tab or in an overlay. Available values are:

• new_tab: opens the payment form in a new tab.
• overlay: opens the payment form in a sliding overlay.

Sets the text of the checkout button.

Whether the button uses a HubSpot payment link or an external link. Choices include:

• payment_link
• custom_link

When button_target is set to custom_link, sets the destination of the external link. Supported link types include:

• EXTERNAL
• CONTENT

The product to display, specified by product ID.

By default, the module includes a button that directs users to the product's set URL. To customize the button destination, include this optional field group along with the following fields:

• button_text: a string that sets the button's text.
• override_product_button: set to true to override the default button link settings. Then, include a button_override object. Learn more about button_override below.

In the group_button field group, this sets the button's URL behavior when override_product_button is set to true.

Includes the following fields:

• no_follow: boolean field for the link's no_follow behavior.
• open_link_in_new_tab: boolean field for the link's open behavior.
• url: an object that specifies the button's destination.

In the url field, you can set the type of destination through the type field, which supports the following content types:

• EXTERNAL: a standard URL. Include the URL in an href field.
• CONTENT: a HubSpot page. Include the page ID in a content_id field.
• PAYMENT: a payment link. Include the payment link in an href field.
• EMAIL_ADDRESS: an email address. Include the address in an href field.

By default, the module will display the product name at the top of the module as an h3. To customize the name, include this optional field group along with the following fields:

• heading_level: the heading size. Can be h1 - h6.
• override_product_name: set to true to specify text rather than the product name.
• name_override: the string that you want to display at the top of the module.

By default, the module will display the product's set description. To customize the description, include this optional field group along with the following fields:

• override_product_description: set to true to customize the product description.
• description_override: a string containing your new description.

By default, the module will display the product's set image. To customize this image, include this optional field group with the following fields:

• override_product_image: set to true to specify a new image. 
• image_override: an object that specifies the new image, including the following properties:
  • alt
  • height
  • loading
  • src
  • width

The text displayed on the download button.

Error message displayed if the download fails.

The heading displayed above the payment section of a quote template.

The type of heading used to display heading_text. Values include h1, h2, h3, h4, h5, h6.

The payment button text.

Button text when a signature is required.

Message that displays when there's an error during checkout.

Message that displays when there's an error when trying to make a payment.

A successful payment status indicator.

A payment processing status indicator.

E-signature explanation text.

Text that displays on the verification button.

Alert text that displays when the signature information can't be retrieved.

A status indicator that appears when the verification request has been successfully sent to the quote signer.

Text that displays when the quote has been successfully signed.

Text displayed at the top of the signature section.

Text that displays next to the signature field.

Text that displays next to the date field.

Text that displays next to the printed name field.

An object containing content for the countersignature section. This object can contain the following fields:

• header: text that displays at the top of the countersignature section.
• countersignature: Text that displays next to the countersignature field.
• date: text that displays next to the date field.
• printed_name: text that displays next to the printed name field.

The title of the line item column. 

Display checkbox to allow users to select additional line item columns from product properties. 

A product property. Choices include: 

• price: price of line item. 
• item_description: description of line item. 
• quantity: number of line items. 
• amount: total cost of line items. 
• hs_recurring_billing_start_date: billing start date for recurring line items. 
• discount: discount amount applies to the line item. 

Select any product property to appear as a line item column header. 

HTML block.

An H3 heading.

Type of RSS feed. Choices include:

• blog - HubSpot hosted blog.
• external - An external RSS feed.

RSS URL to use when rss_feed_type equals external.

Id of the blog to use when rss_feed_type equals blog.

(optional) Id of the tag to filter by when rss_feed_type equals blog.

Maximum number of posts to display.

Include the featured image.

Show the author name.

Text that attributes an author to a post. Displayed when show_author equals true.

Show post summary text.

Limits the length of the summary text when show_detail equals true.

The text which will be displayed for the clickthrough link at the end of a post summary when show_detail equals true.

Show publish date.

Format for the publish date when show_date equals true. Choices include:

• short (ex: 06/11/06 12:00PM)
• medium (ex: Jun 6, 2006 12:00:00 pm)
• long (ex: June 6, 2017 12:00:00 pm EDT)
• MMMM d, yyyy 'at' h:mm a (ex: June 6, 2006 at 12:00 pm)
• h:mm a 'on' MMMM d, yyyy (ex: 12:00 pm on June 6, 2006)

The text that indicates when a post was published when show_date equals true.

Search input label text

Placeholder text for the input field.

Include a search button.

Which content types to include in search results. Object contains the following keys with boolean values:

• website_pages
• landing_pages
• blog_posts
• knowledge_articles

• use_custom_search_results_template (boolean): when set to true, users can select a custom search results page. Default is false.
• path_id (string): the ID of the page that will be used for search results. The referenced page must contain the search results module.

Display featured images for items.

Section header content.

Heading level for the header. Choices include h1 through h6.

Subheading paragraph text for the section.

Simple menu object.

Orientation of the menu. Choices include:

• horizontal
• vertical

This is the destination link that will be shortened for easier sharing on social networks.

Object containing:

• enabled: boolean to enable social item
• custom_link_format: custom URL for socials sharer URL

Object containing:

• enabled: boolean to enable social item
• custom_link_format: custom URL for socials sharer URL

Object containing:

• enabled: boolean to enable social item
• custom_link_format: custom URL for socials sharer URL

Object containing:

• enabled: boolean to enable social item.
• custom_link_format: custom URL for socials sharer URL.
• pinterest_media: image object including:
  • src: image URL.
  • alt: alt-text for the image.

Object containing:

• enabled: boolean to enable social item
• custom_link_format: custom URL for socials sharer URL

Add your text to this parameter.

Type of video. Choices include:

• embed: embed code from an external source.
• hubspot_video: HubSpot hosted video.

HubSpot hosted video. Used when video_type equals hubspot_video.

Supports embed types:

• oembed
  • video: URL for video.
• html: embed code for video.

Override oembed thumbnail image when video_type equals embed and embed_field equals oembed.

Object containing oembed_thumbnail_play_button_color - Color field.

Object containing:

• placeholder_title: text field.
• placeholder_description: text field.

URL for video. URLs from Vimeo and YouTube are supported.

Sets the video to full width (true) or manually set width and height (false).

Max width (px)

Max height (px)

Select from the WhatsApp channels connected to the account.

Select whether the button displays text, a WhatsApp icon, or both. Choices include:

• text_and_icon
• text
• icon

The position of the icon on the button. Choices include left and right.

The button's text.

The icon text for screen readers.