Unaffiliated

Home Documentation & Help
Steamworks Documentation
IWorkshopService Interface
Additional Steam Workshop service methods for publishers. See ISteamRemoteStorage to interact with Steam Workshop items directly.

NOTE: This is a Service interface, methods in this interface should be called with the input_json parameter.

For more info on how to use the Steamworks Web API please see the Web API Overview.

SetItemPaymentRules

POST https://partner.steam-api.com/IWorkshopService/SetItemPaymentRules/v1/
NameTypeRequiredDescription
keystringSteamworks Web API publisher authentication key.
appiduint32The App ID that the item belongs to.
gameitemiduint32
associated_workshop_files{message}
partner_accounts{message}
validate_onlyboolOnly validates the rules and does not persist them.
make_workshop_files_subscribableboolAllow users to subscribe to the workshop items?

Sets the payment rules for a specific item.

NOTE: This call requires a publisher API key to use this method. As such this API MUST be called from a secure server, and can never be used directly by clients!

GetFinalizedContributors

GET https://partner.steam-api.com/IWorkshopService/GetFinalizedContributors/v1/
NameTypeRequiredDescription
keystringSteamworks Web API publisher authentication key.
appiduint32The App ID that the item belongs to.
gameitemiduint32

Get a list of contributors for a specific app/workshop item combination.

NOTE: This call requires a publisher API key to use this method. As such this API MUST be called from a secure server, and can never be used directly by clients!

GetItemDailyRevenue

GET https://partner.steam-api.com/IWorkshopService/GetItemDailyRevenue/v1/
NameTypeRequiredDescription
keystringSteamworks Web API publisher authentication key.
appiduint32The App ID that the item belongs to.
item_iduint32The Workshop item ID to get the revenue of.
date_startuint32
date_enduint32

Get item revenue for a specific app/item definition for a date range.

NOTE: This call requires a publisher API key to use this method. As such this API MUST be called from a secure server, and can never be used directly by clients!

PopulateItemDescriptions

POST https://partner.steam-api.com/IWorkshopService/PopulateItemDescriptions/v1/
NameTypeRequiredDescription
keystringSteamworks Web API publisher authentication key.
appiduint32
languages{message}

Populate block of item descriptions.

NOTE: This call requires a publisher API key to use this method. As such this API MUST be called from a secure server, and can never be used directly by clients!