Steamworks Documentation
Embeddable Widgets
Here are the list of URLs that will transform into widget when your fans read your events or announcement. Simply write the URL in a plain fashion, and they will automatically convert when the event is shown in the store, community or library. You can see them when you preview your event to ensure that the URL is well formatted.

YouTube™

YouTube URL in the following format will automatically transform into an embed that shows the poster image, view count and short summary. When a user interacts with the player, it will expand and provide them the native YouTube controls.

https://www.youtube.com/watch?v=<video id> youtu.be/<video id>

For example, using the Video ID of 'UUn-ET4vv1s' we would see the following widget in your event.

2019-09-17_8-17-04.png

Note: With Youtube, we have a few additional formatting options via the [previewyoutube] tag accessible via the toolbar's import YouTube icon.

Store Product Page

Inserting the URL for your Steam store product page will inject a widget that will let users wishlist (if coming soon), buy or play (if free-to-play) your game right from the event page. This is useful when promoting upcoming or launched DLCs.

However, this should be used sparingly, as events will also appear to your existing fan in the the library, who already have your game in their library. While great to announce new DLC over a short time; always placing your game at the footer of the event will likely annoy your fans.

https://store.steampowered.com/app/<appid>

For example, adding the to Portal 2 will render the following way:

2019-09-17_8-26-30.png

Workshop and Community Items

Inserting a link to any workshop item or community item (artwork, screenshot, game guide etc...) will render as a clickable widget your event or announcement. This is a great way to highlight and sharing the great contributions your community is making about your game.

https://steamcommunity.com/sharedfiles/filedetails/?id=<file id>

For example, here are a few examples from Portal 2's workshop and community hub. You can find the URLs needed by click the item in the hub going to their page, or by clicking the share button on any item in the Steam community.

2019-09-17_8-44-09.png

Preview Events and Announcements


Similar to community items, can insert a link to a previously published event or announcement. This is great way to link the previous posting that is part of a series or another type of past event that is related to the current event.

https://steamcommunity.com/games/<appid or vanity>/announcements/detail/<gid> https://steamcommunity.com/ogg/<appid>/announcements/detail/<gid> https://steamcommunity.com/gid/<official game group's 64-bit steamid>/announcements/detail/<gid>

You can find the URL by hitting the 'Share' button on that previous event. It is perfectly fine to cross list to an event of another game too. Here is an example of the first Portal 2 update event.

2019-09-18_13-59-10.png

Medal.tv


It might be fun to share an epic moment from your gaming sessions in your game's announcements. One way is to embed a short clip via Medal.tv; it becomes instantly playable, loopable and further shareable by your fans.

https://medal.tv/clips/<clid id>

You can grab a clip by hitting copy link from the clips page. Here is an example of what this clip embedded on an events page looks like

Medal offers customization options to add things such as a "Get this on Steam" button to your clips. You can view the clip documentation here.

2019-09-18_16-41-17.png