LogoLogo
  • Welcome
  • Getting Started
  • Integration Methods
  • SDKs
  • Tebex for Unreal Engine 5
  • Tebex for Unity Engine
  • Webstore Builder
    • Overview
    • Getting Started
    • Twig
      • Tags
      • Filters
      • Functions
    • Global Variables
      • basket
      • store
      • page
    • Pages
      • index.html
      • checkout.html
      • username.html
      • options.html
      • package.html
      • cms/page.html
      • category.html
      • layout.html
    • Sidebar Modules
      • module.communitygoal.html
      • module.featuredpackage.html
      • module.giftcardbalance.html
      • module.goal.html
      • module.payments.html
      • module.serverstatus.html
      • module.textbox.html
      • module.topdonator.html
    • Assets
    • Schema
    • Developer Plan
    • Footer
    • Guides
      • Package Slugs
  • Headless API
    • Overview
    • Getting Your Listings
    • Creating a Basket
    • Adding Packages
    • Gifting Packages
    • Applying Discounts / Creator Codes
    • Directing to Checkout
    • Endpoints
    • Postman Config
    • Example Integration
  • Checkout API
    • Overview
    • Headers and Authentication
    • Start the Checkout Process
    • Checkout Webhooks
    • Endpoints
    • Errors
    • Postman Config
  • Tebex.js
    • Overview
    • Integration
    • Events
    • Web Components
    • Custom Render Location
    • NPM
    • GitHub
  • Webhooks
    • Overview
    • Login Webhooks
  • Game Server API
    • Overview
    • Authentication
    • Error Handling
    • Endpoints
  • Affiliate API
    • Overview
    • Referrals
    • Game Types
    • Webhooks
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Webstore Builder
  2. Sidebar Modules

module.communitygoal.html

PreviousSidebar ModulesNextmodule.featuredpackage.html

Last updated 7 months ago

Was this helpful?

The community goal module displays the current progress of a community goal which you have configured within your creator panel on the section.

Variables
Type
Description

module.header

string

The header of the module.

module.communitygoal.image

string

The URL of the image of the community goal hosted on our public CDN.

module.communitygoal.repeatable

boolean

If the community goal is repeatable.

module.communitygoal.times_achieved

string

The number of times the community goal has been reached.

module.communitygoal.description

string

The description of the community goal.

module.bar.style

string

The style of the goal, either striped or animated.

module.displayAmount

boolean

If the amount of the community goal should be displayed on your store.

module.total

string

The total the community goal has currently earned.

module.target

string

The target amount of the community goal.

module.percentage

string

The percentage equivalent of the current total against the target.

Request Variable

If you'd like access to a variable that is not currently available,

community goals
please let us know.