This is a Postman collection for working with WoodWing Studio. The collection itself contains, at this time, a subset of the available API calls. Those that are included in the collection are noted below. All of the Studio API documentation can be found in the SDK docs.
In some cases we have added parameters to the calls so that they may be more useful as a starting point.
When creating this collection we considered three parts of Postman's capabilities:
- Collections
- Environments
- Flows (part of Postman 10)
Please note that to use this collection you will need to create your Environment and, if you wish to use Flows, you'll need to create those as well. Farther down we have included videos to help out with that process.
The relationship between the Collection and the Environments is particularly helpful. Environments allows us to create variables, attach values to the variables and then pass the variable value(s) to subsequent calls. The variables can be used calling each individual call within the collection or you can set up a Flow to use them.
In our environment, named 'WoodWing Studio', we have a variety of variables:
- Studio_Server_URL - Add to the body parameters as {{Studio_Server_URL}}
- Studio_Server_Directory - Server Directory value after the URL. Noted as {{Studio_Server_Directory}}
- User_Name - Add to the body parameters as {{User_Name}}
- Password - Add to the body parameters as {{Password}}
- Current_Ticket - Add to the body parameters as {{Current_Ticket}}
- Publication_ID - Add to the body parameters as {{Publication_ID}}
- Status_ID - Add to the body parameters as {{Status_ID}}
- Object_ID - Add to the body parameters as {{Object_ID}}
- Admin_User_Name - Add to the body parameters as {{Admin_User_Name}}
- Admin_User_Password - Add to the body parameters as {{Admin_User_Password}}
- Admin_Current_Ticket - Add to the body parameters as {{Admin_Current_Ticket}}
- FileUploadURL - Just a reference to '/transferindex.php' file
- Uuid_For_PUT - Variable to hold the UUID generated in the 'PUT' call 'Upload Transfer Server Request' to upload the file. Look in the 'Pre-request Script' area for the actual script.
Flows
Flows are for the creation of a complete set of calls and responses to the API endpoint. Seeing is believing so here is a short video showing the basic creation and usage of a Flow using the Collection and the Environment:
WW-Studio-Collections-Environ-Flow.mp4
- v0.1 - Initial release of the collection
- v0.2 - Added variables to the environment for Publication ID, Status ID and Object ID, Add variables to all of the current Workflow calls
- v0.3 - Added Environment variables (Admin_User_Name, Admin_User_Password, Admin_Current_Ticket) to the Environment. Added 'CreateIssues' to the 'Administration' portion of the collection and did some work to clean up the other existing 'Administration' Requests.
- v0.4 - Added 'SetObjectProperties' to the collection
- v0.5 - Add some calls for a specific use case... creating a Digital Article. See the directory called 'Digital Articles'.
- v0.6 - Added new calls: CreateObjects, SetObjectProperties for Custom Metadata, Admin API - GetUsers, GetUserGroups. Added Environment file to repository. Added variable to Environment for the Studio Directory value called 'Studio_Server_Directory'.
- v0.7 - Fixed: The GetPublications call was using the wrong index for calling the service.
- v0.8 - Added: ModifyUsersRequest has been added to the Administration calls.
- v0.9 - Added: Create Print article section within the collection.
- v0.10 - Added: UnlockObjects call to the collection, added video showing how to use the 'Create Digital Article' portion of the collection.
- v0.11 - Added: Workflow > CreateObjectOperations folder with calls for PlaceDossier, PlaceArticleElement, PlaceImage and ClearFrameContent
- v0.12 - Added: New sample call that creates a Task with Targets (CreateObjects Task with Targets), Added new folder called 'Objects and Targets' and added a call to that folder called 'CreateObjectTargets'
- v0.13 - Added: Connect Webhooks. These calls are here to show how to create Webhooks using the new Connect Webhooks feature. Note that this feature will not be available until May 2025
- v0.14 - Added: CopyObjects call. Also SaveObjects has been available for quite some time but not noted in the available calls below.
- v0.15 - Added: Automatic ticket capture on all 'LogOn' requests (Workflow, Connect Webhooks, Webhooks, Planning, Administration). Test scripts now set Current_Ticket / Admin_Current_Ticket in the environment automatically, so there's no need to copy the ticket by hand after logging in.
- v0.16 - Fixed: Removed hardcoded local file path from 'Upload Transfer Server Request' (Digital Articles and Print Articles) that broke on import for other users. Added a note in the request description prompting users to select their own file before sending.
- v0.17 - Docs: Added folder descriptions to 'Connect Webhooks' and 'Webhooks' clarifying they are two distinct plugins, not duplicates — Connect Webhooks is the intended replacement (richer data, new delivery architecture) and Webhooks is legacy.
- v0.18 - Fixed: Corrected invalid JSON in 'Connect Webhooks > GetWebhookRegistration' (params was wrapped in array brackets instead of an object), which would have failed to send as-is.
-
- v0.19 - Added: 'DeleteLayouts', 'ModifyLayouts', and 'LogOff - Planning' to the Planning folder. Introduced a dedicated 'Planning_Ticket' environment variable, automatically captured by 'LogOn - Planning' and used by all Planning calls, separate from the main Workflow 'Current_Ticket'.
- v0.20 - Added: 'GetPages' and 'GetPagesInfo' to the Workflow folder (previously 'GetPages' incorrectly called the GetPagesInfo method; both now have accurate descriptions).
- v0.21 - Changed: 'Connect Webhooks' and 'Webhooks' folders now log on as admin (Admin_User_Name/Admin_User_Password) and share 'Admin_Current_Ticket' with the Administration folder, rather than using regular user credentials and Current_Ticket.
- v0.22 - Fixed: Corrected the request body structure for 'CreateLayouts' and 'GetStates' to match the current API shape. Enhanced the 'QueryObjects' example with pagination, an additional Publication filter, and extra RequestProps.
- v0.23 - Docs: Added descriptions to the 6 remaining undocumented requests (CreateObjects Digital Article, QueryObjects Digital Article Templates, Download Transfer Server Request under Digital Articles; CreateObjects Print Article, Delete Transfer Server Request, Download Transfer Server Request under Print Articles). Every request in the collection now has documentation.
Located in 'Digital Articles > Supporting Requests'
- Upload Transfer Server request (PUT)
- Delete Transfer Server Request (PUT)
- Download Transfer Server Request (GET)
Additional calls (Copy of already existing calls modified for the use case): Located in 'Digital Articles'
- QueryObjects Digital Article Template
- CreateObjects Digital Article
- [Folder] CreateObjects
- CreateObjects Digital Article
- CreateObjects Task
- [Folder] CreateObjectOperations
- PlaceDossier - Print Article
- PlaceArticleElement
- PlaceImage
- ClearFrameContent
- LogOn
- QueryObjects
- GetObjects
- SaveObjects
- CopyObject
- SetObjectProperties
- SetObjectProperties Custom Metadata
- GetPublications
- GetStates
- DeleteObjects
- GetUsers
- GetServerInfo
- GetUserGroups
- GetUserProfile
- GetUserSettings
- GetNamedQueries
- CheckTicket
- UnlockObjects
- LogOff
- LogOn - Administration
- GetIssues
- CreateIssues
- CopyPublications
- GetUsers
- GetUserGroups
- LogOff - Administration
- LogOn - Planning
- Create Layouts
- LogOn
- GetTriggerOptions
- ListWebhookRegistrations
- CreateWebhookRegistration
- GetWebhookRegistration
- UpdateWebhookRegistration
- DeleteWebhookRegistration
- LogOff
- LogOn
- GetTriggerOptions
- ListWebhookRegistrations
- CreateWebhookRegistration
- GetWebhookRegistration (added August 9, 2023)
- UpdateWebhookRegistration (added August 9, 2023)
- DeleteWebhookRegistration
- LogOff
- Supporting Requests a. Upload Transfer Server Request b. Delete Transfer Server Request c. Download Transfer Server Request
- QueryObjects Digital Article Templates
- CreateObjects Digital Article
- Script to automatically add the ticket to the calls - Complete July 22nd, 2026
- Written runbooks (lowest lift, no new tooling) — a markdown doc per common task (e.g. "Create a Digital Article") listing the exact request sequence to run and what each step sets/consumes (LogOn → QueryObjects Digital Article Templates → Upload Transfer Server Request → CreateObjects Digital Article). This can't be "played" with one click, but it's committable today, and you can still build the equivalent visually on the Flows canvas yourself for anyone who wants to click through it interactively.
User Settings (partial coverage) SaveUserSettings, DeleteUserSettings — collection only has GetUserSettings
Object Targets (partial coverage) UpdateObjectTargets, DeleteObjectTargets — collection only has CreateObjectTargets
Multi-object / alternate property operations
RestoreObjects, LockObjects (counterpart to UnlockObjects)
SysGetSubApplications and the System Admin interface generally. This lines up with something already flagged in an earlier review pass: the collection's "System Administration" folder exists but is completely empty.
Object Relations CreateObjectRelations is covered. These are not: CreateObjectRelationsAsync, GetObjectRelations, UpdateObjectRelation(s), DeleteObjectRelation
Dossier/Object Labels CreateObjectLabels, UpdateObjectLabels, DeleteObjectLabels
Messages SendMessages, DeleteMessage(s)/DeleteMessageIDs
Object Variants / versioning — not covered at all CreateVersion, RestoreVersion, ListVersions, LockForOffline
Generic dialog retrieval GetDialog — a general framework method referenced across several features, not tied to one interface
Video - Using the Postman Collection to create a digital article https://github.com/WoodWing/ww-studio-postman-collection/assets/43406765/37b8c46d-8ade-4b68-a0be-dc9fb1664a15