URL parameters

With URL parameters, you can control spud publishing settings programmatically either through spud code or URL-encoded query strings.

For example:

• Use URL parameters in spud code to display a specific filtered view.
• Use a URL-encoded query string to provide a link to popular event search results.

Tip You can also use URL parameters to control the content of calendar feeds. Find out which URL parameters work with feeds in this table and learn more about feed-specific parameters and custom feed syntax here.

Topic links

• Syntax for URL-encoded query strings
• Syntax for URL parameters in spud code
• Parameters list

Syntax for URL-encoded query strings

URL-encoded query strings consist of parameters and the values you assign to them. You append query strings to the URLs of pages on your site where spuds are embedded.

Tips

• URL parameters are case sensitive and require all lower-case.
• The trumbaEmbed parameter is also case sensitive and must be written exactly as shown.
• You might want to find a site that you like that shows you how to URL-encode common characters such as the ampersand, equals sign, space character, and so on. URL Encoding on Blooberry.com is one example of a helpful site. You can find more by searching the web for URL encoding.

To build an URL to use as a link destination

1. Start with the URL of the page that contains your main calendar spud.

   The rest of this procedure will use https://www.yoursite.com/calendar.html as that URL.

   Tip If you want to create URLs for your hosted calendar page, use the URL https://www.trumba.com/calendars/your calendar name.

2. At the end of the URL, add a question mark (?), and then the trumbaEmbed= parameter (case sensitive):

   https://www.yoursite.com/calendar.html?trumbaEmbed=

   Note If the default URL for your calendar page already contains a query string (a question mark and one or more parameters), instead of typing another question mark, add URL-encoded Trumba Connect parameters to the existing string as described in the next two steps.

3. Add URL-encoded parameters that control the spud display, such as the date parameter, which tells Trumba Connect which date to start with.

   https://www.yoursite.com/calendar.html?trumbaEmbed=date%3D20221205

   In the URLs above, the question mark (?) delimits the base URL and the query strings. %3D is the URL-encoded equals sign (=).

4. Add a separate parameter for each action. To combine parameters, use a URL-encoded ampersand (%26).

   For example, add a parameter to the above URL to change the default view to Classic Day:

   https://www.yoursite.com/calendar.html?trumbaEmbed=date%3D20221205%26template%3Dday

   To make the URL the destination of a link:

   <a href="https://www.yoursite.com/calendar.aspx?trumbaEmbed=date%3D20221205%26template%3Dday">Today's Events!</a>

Syntax for URL parameters in spud code

In spud code, you include URL parameters in the url argument. Each spud, depending upon its purpose, supports a specific set of parameters. The table below lists the spuds (or spud types) that support each parameter.

In the following example, parameters in the url argument set the main calendar view to List and the date with which the event display begins to December 5, 2022.

Tip In the spud code url argument, text parameter values must be surrounded by quotes. Number parameter values do not require quotes.

Tell me more about how to use spud code.

Supported URL Parameters

The following table lists the URL parameters and the spuds that support them. Click a parameter name to learn more.

Note If you add a parameter to a spud that doesn't support it, the unsupported parameter is ignored. For example, the template parameter wouldn't have any effect on a promotion spud, because promotion spuds don't show or control the main calendar view.