Event: kyvos.viewer.onExportStart

This documentation is for Kyvos 2026.5.x. To view documentation for other Kyvos versions, click here.

This documentation is for Kyvos 2026.5.x. To view documentation for other Kyvos versions, click here.

✅ Enterprise: AWS, Azure, GCP, and On-Premises ✅ Marketplace: AWS, Azure, and GCP ✅ SaaS: AWS, Azure, and GCP ✅ Single Node Installation (SNI)

This event will be triggered when export is submitted.

Interface

{"msgId": "",
"msgName": "kyvos.viewer.onExportStart", "payload": {
"info": { "status": "",
"desc": "",
"extDesc": "", "code": 0
},
"data": { "sheetName": "",
"uniqueId": "",
"sheetId": ""
}
}}

Points to consider

The Host App will get sheetName, uniqueId, and sheetId in the payload.

Example

{"msgId": "16929834581252127092052195045033",
"msgName": "kyvos.viewer.onExportStart", "payload": {
"info": {
"status": "success", "desc": "Export started.", "extDesc": "",
"code": 0
},
"data": {
"sheetName": "Sheet 1",
"uniqueId": "Sheet16929832377937653862-16929834581229127093028134279434", "sheetId": "Sheet16929832377937653862"
}
}
},