Codec Server
This page discusses Codec Server.
What is a Codec Server?
A Codec Server is an HTTP/HTTPS server that uses a custom Payload Codec to decode your data remotely through endpoints.
A Codec Server follows the Temporal Codec Server Protocol. It implements two endpoints:
/encode/decode
Each endpoint receives and responds with a JSON body that has a payloads property with an array of Payloads.
The endpoints run the Payloads through a Payload Codec before returning them.
Most SDKs provide example Codec Server implementation samples, listed here:
Usage
When you apply custom encoding with encryption or compression on your Workflow data, it is stored in the encrypted/compressed format on the Temporal Server. For details on what data is encoded, see Securing your data.
To see decoded data when using the Temporal CLI or Web UI to perform some operations on a Workflow Execution, configure the Codec Server endpoint in the Web UI and the Temporal CLI. When you configure the Codec Server endpoints, the Temporal CLI and Web UI send the encoded data to the Codec Server, and display the decoded data received from the Codec Server.
For details on creating your Codec Server, see Codec Server Setup.