The Chains portability API allows you to programmatically export, import, and publish chains across workspaces and organizations. This means chains can be built and tested in a single workspace and then "ported" to other destinations.
For managed service providers and larger businesses, this provides a relatively scalable way to distribute chains versus individually exporting them from the Workiva software.
Note: This process utilizes the Workiva Developer API, so some knowledge of API development is required. We recommend consulting your internal IT team or business partner for assistance; Workiva Support will not be able to help with this process.
What authorizations are needed to use the Chain Portability API?
You will need:
- A valid API grant in both the source and destination workspaces.
- A valid MSP token for both the source and destination workspaces.
What can I do with the Chain Portability API?
The following endpoints are available:
-
Export a chain: This returns a
.chainfile for the provided chain ID. -
Import a chain: This imports the specified
.chainfile into the provided environment, and returns the chain metadata for the imported chain. - Publish a chain: This publishes the chain specified by the chain ID.
Please note that chains must be individually configured in each destination workspace before they are published.
Where do I find the Chain Portability API?
These APIs are available on the Workiva Developer portal.
Can I manually move chains between workspaces?
Yes, individual chains can be imported or exported between workspaces. This is recommended when only a small number of chains need to be moved.
Templates can also be used across multiple workspaces when standardizing your chain workflows.