Event: kyvos.viewer.onWorkbookSave

Event: kyvos.viewer.onWorkbookSave

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

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

Applies to: Kyvos Enterprise  Kyvos Cloud (SaaS on AWS) Kyvos AWS Marketplace

Kyvos Azure Marketplace   Kyvos GCP Marketplace Kyvos Single Node Installation (Kyvos SNI)


This event is triggered when a workbook is saved.

Interface

{ "msgId": "", "msgName": "kyvos.viewer.saveWorkbook"}

Here,

  • wbId = workbook identifier

  • wbName = workbook name

Examples

  1. Success

    { "msgId": "16697102479679127084072174132303", "msgName": "kyvos.viewer.onWorkbookSave", "integrationId": "INT_15984490249402127061084151067457", "payload": { "info": { "status": "success", "desc": "Entity saved successfully", "code": 0 }, "data": { "wbId": "Workbook16696262783109127077025192299897", "wbName": "Workbook 1" } API: kyvos.viewer.revertWorkbook This event would request Kyvos to revert the workbook Interface } }
  2. Failure

    { "msgId": "16697102479679127084072174132303", "msgName": "kyvos.viewer.onWorkbookSave", "integrationId": "INT_15984490249402127061084151067457", "payload": { "info": { "status": "failure", "code": -1, "desc": "Error in saving an entity." }, "data": { "wbId": "Workbook16696262783109127077025192299897", "wbName": "Workbook 1" } } }
  3. Timeout

    { "msgId": "16697102479679127084072174132303", "msgName": "kyvos.viewer.onWorkbookSave", "integrationId": "INT_15984490249402127061084151067457", "payload": { "info": { "status": "failure", "code": -2, "desc": "Timeout error." } } }



Copyright Kyvos, Inc. 2026. All rights reserved.