Metadata

Updateable objects in Zeal, such as Employee Check and Shifts, have a metadata parameter. You can use this parameter to attach key-value data to these Zeal objects. Metadata is useful for storing additional, structured information on an object.

For instance, you could store your descriptions of jobs in the metadata object of a Zeal Shift object or use the metadata object for correlation IDs so you can parse the response from Zeal.

Metadata is not used in any way by Zeal--you may use the metadata object in any way you like. However, please do not store any sensitive information as metadata.

The metadata object can take any and all JSON types.

metadata: {
 "jobID": "19834673",
 "description": "Piecework pay",
}