Listen for events

Use cases

Event listening enables automated, multi-channel notifications and system integrations in response to business events within Quick BI. By linking an event to a push channel, you can send an HTTP POST notification to the push channel's URL whenever a specific action, such as creating a dashboard or publishing a spreadsheet, occurs.

For example, you can receive event notifications for actions in Quick BI, such as creating a dashboard, publishing a spreadsheet, adding a dataset, granting permissions to a report resource, or modifying a report directory.

Configure a custom channel

Create a custom channel

A custom channel delivers system notifications to a user-defined external endpoint.

Configure a custom channel before creating an event listener, so you can select it as a notification destination.

1. On the organization management page, in the left-side navigation pane, choose collaboration > push channel management > custom channel.

2. On the custom channel page, click Create custom channel in the upper-right corner.

3. In the New custom channel webhook dialog box, configure the following parameters.

   

   Parameter	Description
   Name	Enter a name for the custom channel.
   Webhook URL	The destination URL for notifications, which must support POST requests.
   Secret key	Enables signature verification. Quick BI uses this key to sign requests, and your external system uses the same key to verify the signature on incoming requests.
   Test and Save	Sends a test request to the webhook URL. The configuration is saved only if the request is successful (returns a 2xx status code within the timeout period).

   Note

   The maximum timeout for each Quick BI request is 10 seconds.

   If a configured webhook fails more than 10 consecutive times, Quick BI sets its status to 'Inactive' and stops sending notifications to it.

Receiving and verifying webhooks

Quick BI sends notifications as POST requests. Each request includes the following components for verification:

• Request header

  • X-TaskId: The task ID. Use this ID to uniquely identify a task request, check for duplicates, or provide to Quick BI personnel for troubleshooting when an error occurs.

• Request parameters

  • timestamp: A timestamp for the request.

  • nonce: A random string (number used once).

  • sign: The signature for the request.

This information prevents replay attacks and tampering. The signature is generated as follows:

sign = SHA256.digest(timestamp + nonce + token)

The value of token is the secret key generated during creation, and the service recipient must verify that the generated sign matches the expected value.

Event listening configuration

Create an event listening task

You can add event listeners to your business system to monitor business changes in real time.

1. Navigate to Open Platform > Event Center > event listening and click Add Event in the upper-right corner.

2. In the Push Event Configuration dialog box, configure the event details.

   • Business name: Enter a description of the business associated with the event.

   • Push channel: From the drop-down list, select the custom channel for the event. For supported channel types, see Custom Channels.

     Note

     Custom channels appear in the drop-down list only after you create them. For instructions, see the Create a custom channel section.

   • Event listening: Select the events to monitor. The following table describes the supported event types.

     Event category 1	Event category 2	Event type	Event type code
     Report management	Dashboard	Add/modify/save	PAGE.SAVE
     		Publish	PAGE.PUBLISH_ONLINE
     		Unpublish	PAGE.PUBLISH_OFFLINE
     		Delete	PAGE.DELETE
     		Move	PAGE.MOVE
     		Save as	PAGE.SAVE_AS
     	Spreadsheet	Add/modify/save	REPORT.MODIFY
     		Publish	REPORT.PUBLISH_ONLINE
     		Unpublish	REPORT.PUBLISH_OFFLINE
     		Delete	REPORT.DELETE
     		Move	REPORT.MOVE
     		Save as	REPORT.SAVE_AS
     	Ad hoc analysis	Add/modify/save	ANALYSIS.SAVE
     		Publish	ANALYSIS.PUBLISH_ONLINE
     		Unpublish	ANALYSIS.PUBLISH_OFFLINE
     		Delete	ANALYSIS.DELETE
     		Move	ANALYSIS.MOVE
     		Save as	ANALYSIS.SAVE_AS
     	Self-service query	Add/modify/save	DASHBOARD_OFFLINE_QUERY.SAVE
     		Delete	DASHBOARD_OFFLINE_QUERY.DELETE
     		Move	DASHBOARD_OFFLINE_QUERY.MOVE
     		Save as	DASHBOARD_OFFLINE_QUERY.SAVE_AS
     	Data screen	Add/modify/save	SCREEN.SAVE
     		Publish	SCREEN.PUBLISH_ONLINE
     		Unpublish	SCREEN.PUBLISH_OFFLINE
     		Delete	SCREEN.DELETE
     		Move	SCREEN.MOVE
     		Save as	SCREEN.SAVE_AS
     	Data form	Add/modify/save	DATAFORM.MODIFY
     		Delete	DATAFORM.DELETE
     		Move	DATAFORM.MOVE
     		Copy	DATAFORM.COPY_DATAFORM
     Report directory management	Dashboard directory	Add	PAGE_DIRECTORY.ADD
     		Delete	PAGE_DIRECTORY.DELETE
     		Rename	PAGE_DIRECTORY.RENAME
     		Move	PAGE_DIRECTORY.MOVE
     	Spreadsheet directory	Add	REPORT_DIRECTORY.ADD
     		Delete	REPORT_DIRECTORY.DELETE
     		Rename	REPORT_DIRECTORY.RENAME
     		Move	REPORT_DIRECTORY.MOVE
     	Ad hoc analysis directory	Add	ANALYSIS_DIRECTORY.ADD
     		Delete	ANALYSIS_DIRECTORY.DELETE
     		Rename	ANALYSIS_DIRECTORY.RENAME
     		Move	ANALYSIS_DIRECTORY.MOVE
     	Self-service query directory	Add	DASHBOARD_OFFLINE_QUERY_DIRECTORY.ADD
     		Delete	DASHBOARD_OFFLINE_QUERY_DIRECTORY.DELETE
     		Rename	DASHBOARD_OFFLINE_QUERY_DIRECTORY.RENAME
     		Move	DASHBOARD_OFFLINE_QUERY_DIRECTORY.MOVE
     	Data screen directory	Add	SCREEN_DIRECTORY.ADD
     		Delete	SCREEN_DIRECTORY.DELETE
     		Rename	SCREEN_DIRECTORY.RENAME
     		Move	SCREEN_DIRECTORY.MOVE
     	Data form directory	Add	DATAFORM_DIRECTORY.ADD
     		Delete	DATAFORM_DIRECTORY.DELETE
     		Rename	DATAFORM_DIRECTORY.RENAME
     		Move	DATAFORM_DIRECTORY.MOVE
     Dataset management	Dataset	Add/modify/save	CUBE.MODIFY
     		Move	CUBE.MOVE
     		Delete	CUBE.DELETE
     	Dataset directory	Add	CUBE_DIRECTORY.ADD
     		Delete	CUBE_DIRECTORY.DELETE
     		Rename	CUBE_DIRECTORY.MODIFY
     		Move	CUBE_DIRECTORY.MOVE
     Data portal management	Data portal	Add	DATAPORTAL.ADD
     		Modify/save	DATAPORTAL.MODIFY
     		Delete	DATAPORTAL.DELETE
     Permission management	Dashboard	Grant edit permission	PAGE.SHARE_EDITOR
     		Grant view permission	PAGE.SHARE_VIEW
     		Grant export permission	PAGE.SHARE_EXPORT
     		Stop sharing	PAGE.STOP_SHARE
     	Spreadsheet	Grant edit permission	REPORT.SHARE_EDITOR
     		Grant view permission	REPORT.SHARE_VIEW
     		Grant export permission	REPORT.SHARE_EXPORT
     		Stop sharing	REPORT.STOP_SHARE
     	Ad hoc analysis	Grant edit permission	ANALYSIS.SHARE_EDITOR
     		Grant view permission	ANALYSIS.SHARE_VIEW
     		Grant export permission	ANALYSIS.SHARE_EXPORT
     		Stop sharing	ANALYSIS.STOP_SHARE
     	Self-service query	Grant edit permission	DASHBOARD_OFFLINE_QUERY.SHARE_EDITOR
     		Grant view permission	DASHBOARD_OFFLINE_QUERY.SHARE_VIEW
     		Grant export permission	DASHBOARD_OFFLINE_QUERY.SHARE_EXPORT
     		Stop sharing	DASHBOARD_OFFLINE_QUERY.STOP_SHARE
     	Data screen	Grant edit permission	SCREEN.SHARE_EDITOR
     		Grant view permission	SCREEN.SHARE_VIEW
     		Stop sharing	SCREEN.STOP_SHARE
     	Data preparation	Grant edit permission	ETL.SHARE_EDITOR
     		Stop sharing	ETL.STOP_SHARE
     	Data form	Grant edit permission	DATAFORM.SHARE_EDITOR
     		Grant permission to manage all data	DATAFORM.SHARE_MANAGE_ALL_DATA
     		Grant permission to manage own data	DATAFORM.SHARE_MANAGE_OWN_DATA
     		Grant permission to submit data	DATAFORM.SHARE_SUBMIT_DATA
     		Stop sharing	DATAFORM.STOP_SHARE
     	Dataset	Grant edit permission	CUBE.SHARE_EDITOR
     		Grant use permission	CUBE.SHARE_USE
     		Stop sharing	CUBE.STOP_SHARE
     	Data source	Grant edit permission	DATASOURCE.SHARE_EDITOR
     		Grant use permission	DATASOURCE.SHARE_USE
     		Stop sharing	DATASOURCE.STOP_SHARE
     	Data portal	Grant edit permission	DATAPRODUCT.SHARE_EDITOR
     		Stop sharing	DATAPRODUCT.STOP_SHARE
     	Data portal menu	Grant export permission	MENU.SHARE_EXPORT
     		Grant view permission	MENU.SHARE_VIEW
     		Grant permission to manage all data	MENU.SHARE_MANAGE_ALL_DATA
     		Grant permission to manage own data	MENU.SHARE_MANAGE_OWN_DATA
     		Grant permission to submit data	MENU.SHARE_SUBMIT_DATA
     		Stop sharing	MENU.STOP_SHARE
     Data consumption collaboration	Q report comment	Create comment	QREPORT.ADD_COMMENT
     		Reply to comment	QREPORT.REPLY_COMMENT
     		Delete comment	QREPORT.DELETE_COMMENT

Response data structure

Each event type has a specific data structure. While these structures vary, they all include a common set of attributes. The overall event object consists of a schema version, a header, and a body.

Event header

The event header is stored in the header object. The following table describes its fields.

Event body

The event body is stored in the event object. The following table describes its fields.

Report management: Event API

After you configure an event listener task for report operation events, refer to the following event interface descriptions. You can then trigger and test these events by performing the relevant business operations.

Report actions

Event type:

Event Description: Use this event to track report operations: add, modify, save, and save as.

Event body:

[operator] added, edited, saved, or saved as the report [targetId/targetName/targetType] at [createTime] in directory [directoryId/directoryName] within workspace [workspaceId/workspaceName].

Example of a dashboard-save event body:

{
    "schema": "1.0",
    "header": {
        "organizationId": "2fe4fbd8-588f-xxxx-xxxx-e92c7af083ea",
        "eventId": "b8283dd4-xxxx-xxxx-be7b-71570980566f",
        "createTime": "1676xxxx41512",
        "eventType": "PAGE.SAVE"
    },
    "event": {
        "targetName": "template push",
        "targetId": "04c67d55-xxxx-xxxx-xxxx-713286e40eed",
        "targetType": "PAGE",
        "operatorId": "f1f4ab86b0fxxxxe2fbe0a204675a1",
        "extraInfo": {
            "directoryId": "7508891f-xxxx-xxxx-a65a-a6c4709cbdc6",
            "workspaceName": "test workspace",
            "directoryName": "template push test",
            "workspaceId": "83619b9f-8f8c-xxxx-xxxx-55bf69cdb59b"
        }
    }
}

Report publication event

Event type:

Event description: Triggered when a report is published.

Event body:

This indicates that [operator] published a report [targetId/targetName/targetType] in the workspace [workspaceId/workspaceName] at [createTime].

Example event body for a dashboard-publish event:

{
    "schema": "1.0",
    "header": {
        "organizationId": "2fe4fbd8-xxxx-489a-xxxx-e92c7af083ea",
        "eventId": "0152f2ab-xxxx-40c4-xxxx-c206a215d72c",
        "createTime": "1676863096609",
        "eventType": "PAGE.PUBLISH_ONLINE"
    },
    "event": {
        "targetName": "test template import_2022_10_31_20_13_12_723",
        "targetId": "0857b0bc-xxxx-4058-xxxx-f926b15ae003",
        "targetType": "PAGE",
        "operatorId": "f1f4ab86b0faxxxxe2fbe0a204675a1",
        "extraInfo": {
            "workspaceName": "test workspace",
            "workspaceId": "83619b9f-xxxx-4824-xxxx-55bf69cdb59b"
        }
    }
}

Report deprecation event

Event Type: PAGE.PUBLISH_OFFLINE

This event triggers when a report goes offline.

Event body:

The event body indicates that [operator] took the dashboard [targetId/targetName/targetType] offline in the workspace [workspaceId/workspaceName] at [createTime].

Example event body for the "dashboard offline" event:

{
    "schema": "1.0",
    "header": {
        "organizationId": "2fe4fbd8-xxxx-xxxx-b3e1-e92c7af083ea",
        "eventId": "50112a64-xxxx-xxxx-ace2-d74900902ebc",
        "createTime": "167xxxx254588",
        "eventType": "PAGE.PUBLISH_OFFLINE"
    },
    "event": {
        "targetName": "testxxxx_2022_10_31_20_13_12_723",
        "targetId": "0857b0bc-573b-xxxx-xxxx-f926b15ae003",
        "targetType": "PAGE",
        "operatorId": "f1f4ab86b0faxxxxe2fbe0a204675a1",
        "extraInfo": {
            "workspaceName": "test workspace",
            "workspaceId": "83619b9f-xxxx-xxxx-xxxx-55bf69cdb59b"
        }
    }
}

Report deletion event

Event type: PAGE.DELETE

Event Description: Triggers when a report is deleted.

Event body:

This event body indicates that [operator] deleted the report [targetId/targetName/targetType] in the workspace [workspaceId/workspaceName] at [createTime].

Example: Deleting a dashboard

{
    "schema": "1.0",
    "header": {
        "organizationId": "b5fb3d10-b9e9-xxxx-xxxx-cf47d6aec920",
        "eventId": "de46f9e8-8471-xxxx-xxxx-119a13d124d7",
        "createTime": "16772xxxx8960",
        "eventType": "PAGE.DELETE"
    },
    "event": {
        "targetName": "Dashboard Regression",
        "targetId": "3fef2261-664c-xxxx-xxxx-4de6e1788124",
        "targetType": "PAGE",
        "operatorId": "fec07414432xxxxb1905061e6a951a2",
        "extraInfo": {
            "directoryId": "f1a8fb0e-df93-xxxx-xxxx-7ba8b43ba960",
            "workspaceName": "test workspace",
            "directoryName": "V453",
            "workspaceId": "4d86aec9-14f7-xxxx-xxxx-6de40d6386ad"
        }
    }
}

Report move event

Event type:

event description: Use this event to listen for report movement.

Event body:

This event shows that [operator] moved the dashboard [targetId/targetName/targetType] to the directory [directoryId/directoryName] in the workspace [workspaceId/workspaceName] at [createTime].

Example "ad-hoc analysis move" event body:

{
    "schema": "1.0",
    "header": {
        "organizationId": "2fe4fbd8-xxxx-489a-xxxx-e92c7af083ea",
        "eventId": "b1ba8499-5745-xxxx-xxxx-f146da27fc89",
        "createTime": "1676897694386",
        "eventType": "ANALYSIS.MOVE"
    },
    "event": {
        "targetName": "Unnamed ad-hoc analysis",
        "targetId": "2165d7b8-xxxx-4412-xxxx-6a4f92ca272f",
        "targetType": "ANALYSIS",
        "operatorId": "f1f4ab86b0faxxxxe2fbe0a204675a1",
        "extraInfo": {
            "directoryId": "8a2d84ac-xxxx-45ce-xxxx-6210687aae48",
            "workspaceName": "test workspace",
            "directoryName": "wdeqwd",
            "workspaceId": "83619b9f-xxxx-4824-xxxx-55bf69cdb59b"
        }
    }
}

Item directory event API

Create item directory

Event types:

This event triggers when an item directory is created.

Event body:

This event indicates that at createTime, user operatorId created directory targetId/targetName (type targetType) in the parent directory directoryId/directoryName in workspace workspaceId/workspaceName.

Example of a "Create dashboard directory" event:

{
    "schema": "1.0",
    "header": {
        "organizationId": "2fe4fbd8-xxxx-xxxx-b3e1-e92c7af083ea",
        "eventId": "084b72bc-xxxx-xxxx-8c94-34f28fc109fd",
        "createTime": "1676xxxx22991",
        "eventType": "PAGE_DIRECTORY.ADD"
    },
    "event": {
        "targetName": "new-directory-example",
        "targetId": "6f113f65-90fa-xxxx-xxxx-4a94fe28d5e8",
        "targetType": "PAGE_DIRECTORY",
        "operatorId": "f1f4ab86b0fa44xxxx2fbe0a204675a1",
        "extraInfo": {
            "directoryId": "-1",
            "workspaceName": "Test Workspace",
            "directoryName": "root directory",
            "workspaceId": "83619b9f-xxxx-xxxx-a87f-55bf69cdb59b"
        }
    }
}

Rename item directory

Event types:

This event triggers when an item directory is renamed.

Event body:

This event indicates that at createTime, user operatorId renamed the directory from originalDirectoryName to targetName in workspace workspaceId/workspaceName. The directory ID remains targetId.

Example of a "Rename dashboard directory" event:

{
    "schema": "1.0",
    "header": {
        "organizationId": "b5fb3d10-xxxx-4a7d-xxxx-cf47d6aec920",
        "eventId": "87473a10-xxxx-4d61-xxxx-2017ba082802",
        "createTime": "1677047794924",
        "eventType": "PAGE_DIRECTORY.RENAME"
    },
    "event": {
        "targetName": "new-directory-name-example",
        "targetId": "ed8d7194-xxxx-42c1-xxxx-4d00c7892056",
        "targetType": "PAGE_DIRECTORY",
        "operatorId": "fec0741443204xxxx05061e6a951a2",
        "extraInfo": {
            "originalDirectoryId": "ed8d7194-xxxx-42c1-xxxx-4d00c7892056",
            "workspaceName": "Test Resource Package Import",
            "originalDirectoryName": "old-directory-name-example",
            "workspaceId": "3e60ee7f-xxxx-4231-xxxx-f6d25fcaa886"
        }
    }
}

Delete item directory

Event types:

This event triggers when an item directory is deleted.

Event body:

This event indicates that at createTime, user operatorId deleted directory targetId/targetName (type targetType) from the parent directory directoryId/directoryName in workspace workspaceId/workspaceName.

Example of a "Delete dashboard directory" event:

{
    "schema": "1.0",
    "header": {
        "organizationId": "b5fb3d10-xxxx-xxxx-9f20-cf47d6aec920",
        "eventId": "420aa716-fa7exxxx4306-xxxx-5bf154213618",
        "createTime": "1677203667959",
        "eventType": "PAGE_DIRECTORY.DELETE"
    },
    "event": {
        "targetName": "directory-to-delete-example",
        "targetId": "6a8fdc4c-94ac-xxxx-9e3b-ffd40578973b",
        "targetType": "PAGE_DIRECTORY",
        "operatorId": "fec0741443204xxxx05061e6a951a2",
        "extraInfo": {
            "directoryId": "-1",
            "workspaceName": "Test Workspace",
            "directoryName": "root directory",
            "workspaceId": "4d86aec9-14f7-xxxx-v-6de40d6386ad"
        }
    }
}

Move item directory

Event types:

This event triggers when an item directory is moved.

Event body:

This event indicates that at createTime, user operatorId moved directory targetId/targetName (type targetType) to the destination directory directoryId/directoryName in workspace workspaceId/workspaceName.

Example of a "Move dashboard directory" event:

{
    "schema": "1.0",
    "header": {
        "organizationId": "b5fb3d10-xxxx-xxxx-9f20-cf47d6aec920",
        "eventId": "a2782313-db6e-xxxx-xxxx-81b96d0cb77b",
        "createTime": "16770xxxx985",
        "eventType": "PAGE_DIRECTORY.MOVE"
    },
    "event": {
        "targetName": "test-directory",
        "targetId": "95fb0822-197f-xxxx-xxxx-3087aa510d93",
        "targetType": "PAGE_DIRECTORY",
        "operatorId": "fec07414432xxxx905061e6a951a2",
        "extraInfo": {
            "directoryId": "-1",
            "workspaceName": "Test Workspace",
            "directoryName": "root directory",
            "workspaceId": "3e60ee7f-a99f-xxxx-xxxx-f6d25fcaa886"
        }
    }
}

Dataset management events

Dataset create, update, and save

Event type: CUBE.MODIFY

Event description: Triggered when a dataset is saved.

Since: ind_v4.5.3

Event body:

This event body indicates that at [createTime], [operator] created a dataset ([targetId/targetName/targetType]) in the directory ([directoryId/directoryName]) in the workspace ([workspaceId/workspaceName]).

Example: The body of a "save dataset" event:

{
    "schema": "1.0",
    "header": {
        "organizationId": "b5fb3d10-xxxx-xxxx-9f20-cf47d6aec920",
        "eventId": "4332e2c3-xxxx-xxxx-a447-c1d938766cf1",
        "createTime": "16770xxxx5986",
        "eventType": "CUBE.MODIFY"
    },
    "event": {
        "targetName": "test",
        "targetId": "9f7ab6fd-xxxx-xxxx-9df6-f63e735cb3f2",
        "targetType": "CUBE",
        "operatorId": "fec07414432xxxx4b1905061e6a951a2",
        "extraInfo": {
            "directoryId": "-1",
            "workspaceName": "test import",
            "directoryName": "root directory",
            "workspaceId": "3e60ee7f-a99f-xxxx-xxxx-f6d25fcaa886"
        }
    }
}

Move a dataset

Event type: CUBE.MOVE

Event description: A dataset was moved.

Available since: ind_v4.5.3

Event body:

At [createTime], the operator [operator] moved the dashboard [targetId/targetName/targetType] to the directory [directoryId/directoryName] in the workspace [workspaceId/workspaceName].

Example "ad-hoc analysis move" event body:

{
    "schema": "1.0",
    "header": {
        "organizationId": "2fe4fbd8-58xxxx8f-xxxx-b3e1-e92c7af083ea",
        "eventId": "b1ba8499-5745-xxxx-xxxx-f146da27fc89",
        "createTime": "16768xxxx94386",
        "eventType": "ANALYSIS.MOVE"
    },
    "event": {
        "targetName": "unnamed ad hoc analysis",
        "targetId": "2165d7b8-xxxx-4412-xxxx-6a4f92ca272f",
        "targetType": "ANALYSIS",
        "operatorId": "f1f4ab86b0fxxxxe2fbe0a204675a1",
        "extraInfo": {
            "directoryId": "8a2d84ac-xxxx-45cexxxxabe3-6210687aae48",
            "workspaceName": "test workspace",
            "directoryName": "wdeqwd",
            "workspaceId": "83619b9f-xxxx-xxxx-a87f-55bf69cdb59b"
        }
    }
}

Dataset deletion

Event type: CUBE.DELETE

event description: Triggers when a dataset is deleted.

@since ind_v4.5.3

Event body:

[operator] moved the dashboard [targetId/targetName/targetType] to the directory [directoryId/directoryName] in the workspace [workspaceId/workspaceName] at [createTime].

Example event body for "ad-hoc analysis move":

{
    "schema": "1.0",
    "header": {
        "organizationId": "b5fb3d10-xxxx-4a7dxxxx9f20-cf47d6aec920",
        "eventId": "d8acd8be-46b2-xxxx-xxxx-d46f80ffb008",
        "createTime": "167705xxxx0252",
        "eventType": "CUBE.DELETE"
    },
    "event": {
        "targetName": "null",
        "targetId": "8c9f808f-xxxx-xxxx-8e3a-788d7514b864",
        "targetType": "CUBE",
        "operatorId": "fec07414432xxxx4b1905061e6a951a2",
        "extraInfo": {
            "workspaceName": "Test Workspace",
            "workspaceId": "3e60ee7f-xxxx-xxxx-9138-f6d25fcaa886"
        }
    }
}

Dataset directory creation

Event type: CUBE_DIRECTORY.MODIFY

Event description: Triggers when a new dataset directory is created.

@since ind_v4.5.3

Event body

This event body reports that [operator] created a directory [targetId/targetName/targetType] in directory [directoryId/directoryName] within workspace [workspaceId/workspaceName] at [createTime].

Example: "Create Dataset Catalog" event body

{
    "schema": "1.0",
    "header": {
        "organizationId": "b5fb3d10-xxxx-4a7d-xxxx-cf47d6aec920",
        "eventId": "2ce66456-xxxx-4271-xxxx-a6170c4df59d",
        "createTime": "1677203977445",
        "eventType": "CUBE_DIRECTORY.ADD"
    },
    "event": {
        "targetName": "Test Method",
        "targetId": "9283fe90-xxxx-4206-xxxx-57581b53542a",
        "targetType": "CUBE_DIRECTORY",
        "operatorId": "fec0741443204xxxx05061e6a951a2",
        "extraInfo": {
            "directoryId": "-1",
            "workspaceName": "Test Workspace",
            "directoryName": "root directory",
            "workspaceId": "4d86aec9-xxxx-493e-xxxx-6de40d6386ad"
        }
    }
}

Dataset directory renaming

Event type: CUBE_DIRECTORY.MODIFY

Event description: Triggered when a work directory is renamed.

Available since: ind_v4.5.3

Event body:

At [createTime], [operator] renamed a directory from [originalDirectoryName/originalDirectoryId] to [targetId/targetName/targetType] within the parent directory [directoryId/directoryName] in workspace [workspaceId/workspaceName].

Example of a "dataset directory rename" event body:

{
    "schema": "1.0",
    "header": {
        "organizationId": "b5fb3d10-xxxx-xxxx-9f20-cf47d6aec920",
        "eventId": "005593c0-3904-xxxx-xxxx-49eb08056fe8",
        "createTime": "167xxxx05737",
        "eventType": "CUBE_DIRECTORY.MODIFY"
    },
    "event": {
        "targetName": "method gym",
        "targetId": "f098d41a-v-xxxx-992f-f0eeadbf758c",
        "targetType": "CUBE_DIRECTORY",
        "operatorId": "fec0741443204xxxx05061e6a951a2",
        "extraInfo": {
            "originalDirectoryId": "f098d41a-xxxx-xxxx-992f-f0eeadbf758c",
            "workspaceName": "test workspace",
            "originalDirectoryName": "method",
            "workspaceId": "4d86aec9-14f7-xxxx-xxxx-6de40d6386ad"
        }
    }
}

Dataset directory deletion

Event type: CUBE_DIRECTORY.DELETE

This event is triggered when a dataset directory is deleted.

Since: ind_v4.5.3

Event body:

This event body shows that at [createTime], [operator] deleted the directory [targetId/targetName/targetType] from directory [directoryId/directoryName] in workspace [workspaceId/workspaceName].

Example event body for deleting a dataset directory:

{
    "schema": "1.0",
    "header": {
        "organizationId": "b5fb3d10-xxxx-4a7d-xxxx-cf47d6aec920",
        "eventId": "635a0094-3941-xxxx-xxxx-692dbeaeabc5",
        "createTime": "1677xxxx6406",
        "eventType": "CUBE_DIRECTORY.DELETE"
    },
    "event": {
        "targetName": "null",
        "targetId": "2e07d9ce-xxxx-xxxx-b0a1-db1dcf614e96",
        "targetType": "CUBE_DIRECTORY",
        "operatorId": "fec07414xxxx4b1905061e6a951a2",
        "extraInfo": {
            "workspaceName": "test workspace",
            "workspaceId": "4d86aec9-xxxx-xxxx-b1d8-6de40d6386ad"
        }
    }
}

Dataset directory movement

Event Type: CUBE_DIRECTORY.MOVE

Occurs when a work directory is moved.

Starting version: @since ind_v4.5.3

Event body:

This event indicates that [operator] moved the directory [targetId/targetName/targetType] to the directory [directoryId/directoryName] in the workspace [workspaceId/workspaceName] at [createTime].

Example of a dataset directory move event body:

{
    "schema": "1.0",
    "header": {
        "organizationId": "b5fb3d10-xxxx-xxxx-9f20-cf47d6aec920",
        "eventId": "77f565ae-xxxx-xxxx-a63b-8b2e5a684019",
        "createTime": "1677xxxx2297",
        "eventType": "CUBE_DIRECTORY.MOVE"
    },
    "event": {
        "targetName": "V45 date type",
        "targetId": "f5f86731-04cd-xxxx-xxxx-48600f159c2b",
        "targetType": "CUBE_DIRECTORY",
        "operatorId": "fec07414432041xxxx5061e6a951a2",
        "extraInfo": {
            "directoryId": "f098d41a-xxxx-xxxx-992f-f0eeadbf758c",
            "workspaceName": "test workspace",
            "directoryName": "method gym",
            "workspaceId": "4d86aec9-14f7-xxxx-xxxx-6de40d6386ad"
        }
    }
}

Data portal management events

Create a data portal

• Event type: DATAPORTAL.ADD

• Description: Occurs when a data portal is created.

• Available since: ind_v4.6.0.2

• Event body:

This event indicates that at [createTime], an operator with the ID [operatorId] created the data portal [targetId/targetName] in the workspace [workspaceId/workspaceName].

• Example of a data portal creation event:

{
    "schema": "1.0",
    "header": {
        "organizationId": "2fe4fbd8-xxxx-489a-xxxx-e92c7af083ea",
        "eventId": "6bfb14a1-xxxx-4be3-xxxx-73cec74d2fd4",
        "createTime": "1683276951024",
        "eventType": "DATAPORTAL.ADD"
    },
    "event": {
        "targetName": "New Site",
        "targetId": "e5294d62-xxxx-433b-xxxx-2178623b319c",
        "targetType": "DATAPORTAL",
        "operatorId": "9ab47db9xxxx4098axxxx8e6cca0d465",
        "extraInfo": {
            "workspaceName": "Test Space",
            "workspaceId": "0def8c85-xxxx-40f6-xxxx-0de02ed4e175"
        }
    }
}

Modify a data portal

• Event type: DATAPORTAL.MODIFY

• Description: Occurs when a data portal is modified.

• Available since: ind_v4.6.0.2

• Event body:

This event indicates that at [createTime], an operator with the ID [operatorId] modified the data portal [targetId/targetName] in the workspace [workspaceId/workspaceName].

• Example of a data portal modification event:

{
    "schema": "1.0",
    "header": {
        "organizationId": "2fe4fbd8-xxxx-489a-xxxx-e92c7af083ea",
        "eventId": "6bfb14a1-xxxx-4be3-xxxx-73cec74d2fd4",
        "createTime": "1683276951024",
        "eventType": "DATAPORTAL.MODIFY"
    },
    "event": {
        "targetName": "New Site",
        "targetId": "e5294d62-xxxx-433b-xxxx-2178623b319c",
        "targetType": "DATAPORTAL",
        "operatorId": "9ab47db9xxxx4098axxxx8e6cca0d465",
        "extraInfo": {
            "workspaceName": "Test Space",
            "workspaceId": "0def8c85-xxxx-40f6-xxxx-0de02ed4e175"
        }
    }
}

Delete a data portal

• Event type: DATAPORTAL.DELETE

• Description: Occurs when a data portal is deleted.

• Available since: ind_v4.6.0.2

• Event body:

This event indicates that at [createTime], an operator with the ID [operatorId] deleted the data portal [targetId/targetName] from the workspace [workspaceId/workspaceName].

• Example of a data portal deletion event:

{
    "schema": "1.0",
    "header": {
        "organizationId": "2fe4fbd8-xxxx-489a-xxxx-e92c7af083ea",
        "eventId": "6bfb14a1-xxxx-4be3-xxxx-73cec74d2fd4",
        "createTime": "1683276951024",
        "eventType": "DATAPORTAL.DELETE"
    },
    "event": {
        "targetName": "New Site",
        "targetId": "e5294d62-xxxx-433b-xxxx-2178623b319c",
        "targetType": "DATAPORTAL",
        "operatorId": "9ab47db9xxxx4098axxxx8e6cca0d465",
        "extraInfo": {
            "workspaceName": "Test Space",
            "workspaceId": "0def8c85-xxxx-40f6-xxxx-0de02ed4e175"
        }
    }
}

Authorization management events API

When you create an event subscription task that includes authorization operation events, refer to the following event API descriptions. To trigger and test each event, perform the corresponding business operation.

Report authorization event

• Event type:

  Event type	Description	Available since
  PAGE.SHARE_EDITOR	Grants edit permission for a dashboard	ind_v5.1.2
  PAGE.SHARE_VIEW	Grants view permission for a dashboard	ind_v5.1.2
  PAGE.SHARE_EXPORT	Grants export permission for a dashboard	ind_v5.1.2
  PAGE.STOP_SHARE	Stops sharing a dashboard	ind_v5.1.2
  REPORT.SHARE_EDITOR	Grants edit permission for a spreadsheet	ind_v5.1.2
  REPORT.SHARE_VIEW	Grants view permission for a spreadsheet	ind_v5.1.2
  REPORT.SHARE_EXPORT	Grants export permission for a spreadsheet	ind_v5.1.2
  REPORT.STOP_SHARE	Stops sharing a spreadsheet	ind_v5.1.2
  ANALYSIS.SHARE_EDITOR	Grants edit permission for an ad-hoc analysis	ind_v5.1.2
  ANALYSIS.SHARE_VIEW	Grants view permission for an ad-hoc analysis	ind_v5.1.2
  ANALYSIS.SHARE_EXPORT	Grants export permission for an ad-hoc analysis	ind_v5.1.2
  ANALYSIS.STOP_SHARE	Stops sharing an ad-hoc analysis	ind_v5.1.2
  DASHBOARD_OFFLINE_QUERY.SHARE_EDITOR	Grants edit permission for an ad-hoc query	ind_v5.1.2
  DASHBOARD_OFFLINE_QUERY.SHARE_VIEW	Grants view permission for an ad-hoc query	ind_v5.1.2
  DASHBOARD_OFFLINE_QUERY.SHARE_EXPORT	Grants export permission for an ad-hoc query	ind_v5.1.2
  DASHBOARD_OFFLINE_QUERY.STOP_SHARE	Stops sharing an ad-hoc query	ind_v5.1.2
  SCREEN.SHARE_EDITOR	Grants edit permission for a data screen	ind_v5.1.2
  SCREEN.SHARE_VIEW	Grants view permission for a data screen	ind_v5.1.2
  SCREEN.STOP_SHARE	Stops sharing a data screen	ind_v5.1.2

• Event description: Events related to resource authorization.

• Event body:

  Parameter	Type	Description
  schema	string	The event schema.
  header	event_header	The event header.
  eventId	string	The event ID.
  eventType	string	The event type.
  createTime	string	The event creation time, as a timestamp.
  organizationId	string	The unique identifier for the Quick BI organization in which the event occurred.
  event	-	-
  operatorId	string	The user ID of the operator. This is the unique identifier for a user within a Quick BI organization.
  targetId	string	The ID of the target resource, such as a dashboard or spreadsheet.
  targetName	string	The name of the target resource.
  targetType	string	The target type. Valid values: PAGE: dashboard REPORT: spreadsheet ANALYSIS: ad-hoc analysis DASHBOARD_OFFLINE_QUERY: ad-hoc query SCREEN: data screen
  grantedId	string	The grantee ID.
  grantedType	string	The grantee type. Valid values: USER: user ALLUSER: all organization members WORKSPACEUSER: all workspace members USERGROUP: user group

  This event indicates that at createTime, an operator (operatorId) grants permissions on a resource (identified by targetId, targetName, and targetType) to a grantee (identified by grantedId and grantedType).

• Example of a resource authorization event body:

{
  "schema": "1.0",
  "header": {
    "organizationId": "2fe4fbd8-588f-489a-b3e1-e92c7af083ea",
    "eventId": "637c2c83-6e12-465b-8dc9-e5864586cf24",
    "createTime": "1716433937829",
    "eventType": "PAGE.SHARE_EDITOR"
  },
  "event": {
    "targetName": "untitled_202404111755_copy",
    "grantedId": "39735014-1eab-44ac-b94b-f0947990d6df",
    "targetId": "8c699d2e-a5f1-4d48-9dd1-e91e060f5894",
    "grantedType": "WORKSPACEUSER",
    "targetType": "PAGE",
    "operatorId": "f1f4ab86b0fa44519e2fbe0a204675a1"
  }
}

Data preparation, dataset, and data source authorization events

• Event type:

  Event type	Description	Initial version
  ETL.SHARE_EDITOR	Authorizes editing of data preparation.	ind_v5.1.2
  ETL.STOP_SHARE	Revokes authorization for data preparation.	ind_v5.1.2
  CUBE.SHARE_EDITOR	Authorizes editing of a dataset.	ind_v5.1.2
  CUBE.SHARE_USE	Authorizes use of a dataset.	ind_v5.1.2
  CUBE.STOP_SHARE	Revokes authorization for a dataset.	ind_v5.1.2
  DATASOURCE.SHARE_EDITOR	Authorizes editing of a data source.	ind_v5.1.2
  DATASOURCE.SHARE_USE	Authorizes use of a data source.	ind_v5.1.2
  DATASOURCE.STOP_SHARE	Revokes authorization for a data source.	ind_v5.1.2

• Describes events related to authorization changes for data preparation, datasets, and data sources.

• The structure of the event body is as follows:

  Parameter	Type	Description
  schema	string	The event schema.
  header	event_header	The event header.
  eventId	string	The event ID.
  eventType	string	The event type.
  createTime	string	The timestamp when the event was created.
  organizationId	string	The ID of the organization where the event occurred.
  event	-	-
  operatorId	string	The ID of the user who performed the action. This ID is a unique identifier for a user within a Quick BI organization.
  targetId	string	The ID of the target resource.
  targetName	string	The name of the target resource.
  targetType	string	The type of the target resource. Valid values: ETL: data preparation CUBE: dataset DATASOURCE: data source
  grantedId	string	The ID of the grantee.
  grantedType	string	The type of the grantee. Valid values: USER: user ALLUSER: All organization members WORKSPACEUSER: All workspace members USERGROUP: user group

  This event signifies that at [createTime], the user [operatorId] granted the principal [grantedId] ([grantedType]) authorization for the resource [targetName] ([targetType]).

• Example of an event body:

{
  "schema": "1.0",
  "header": {
    "organizationId": "2fe4fbd8-588f-489a-b3e1-e92c7af083ea",
    "eventId": "637c2c83-6e12-465b-8dc9-e5864586cf24",
    "createTime": "1716433937829",
    "eventType": "ETL.SHARE_EDITOR"
  },
  "event": {
    "targetName": "Untitled_202404111755_copy",
    "grantedId": "39735014-1eab-44ac-b94b-f0947990d6df",
    "targetId": "8c699d2e-a5f1-4d48-9dd1-e91e060f5894",
    "grantedType": "WORKSPACEUSER",
    "targetType": "ETL",
    "operatorId": "f1f4ab86b0fa44519e2fbe0a204675a1"
  }
}

Data entry authorization

• Event type:

  Event type	Description	Initial version
  DATAFORM.SHARE_EDITOR	Authorize editing	ind_v5.1.2
  DATAFORM.SHARE_MANAGE_ALL_DATA	Authorize management of all data	ind_v5.1.2
  DATAFORM.SHARE_MANAGE_OWN_DATA	Authorize management of own data	ind_v5.1.2
  DATAFORM.SHARE_SUBMIT_DATA	Authorize data submission	ind_v5.1.2
  DATAFORM.STOP_SHARE	Revoke authorization	ind_v5.1.2

• Event description: Events for managing data entry permissions.

• Event body:

  Parameter	Type	Description
  schema	string	The event schema.
  header	event_header	The event header.
  eventId	string	The event ID.
  eventType	string	The event type.
  createTime	string	The event's creation timestamp.
  organizationId	string	The ID of the event's organization.
  event	-	-
  operatorId	string	The ID of the user in the Quick BI organization who triggered the event.
  targetId	string	The ID of the report.
  targetName	string	The name of the report.
  targetType	string	The type of the target object. DATAFORM: data entry
  grantedId	string	The ID of the grantee.
  grantedType	string	The type of the grantee. USER: User ALLUSER: All organization members WORKSPACEUSER: All workspace members USERGROUP: user group

  This event signifies that at [createTime], the operator ([operatorId]) granted permissions to a grantee ([grantedId], [grantedType]) for the data entry report ([targetId], [targetName]).

• Example event body for data entry authorization:

{
  "schema": "1.0",
  "header": {
    "organizationId": "2fe4fbd8-588f-489a-b3e1-e92c7af083ea",
    "eventId": "637c2c83-6e12-465b-8dc9-e5864586cf24",
    "createTime": "1716433937829",
    "eventType": "DATAFORM.SHARE_EDITOR"
  },
  "event": {
    "targetName": "Untitled_202404111755_copy",
    "grantedId": "39735014-1eab-44ac-b94b-f0947990d6df",
    "targetId": "8c699d2e-a5f1-4d48-9dd1-e91e060f5894",
    "grantedType": "WORKSPACEUSER",
    "targetType": "DATAFORM",
    "operatorId": "f1f4ab86b0fa44519e2fbe0a204675a1"
  }
}

Data portal authorization event

• Event type:

  Event type	Description	Since version
  DATAPRODUCT.SHARE_EDITOR	Grants edit permission for a data portal.	ind_v5.1.2
  DATAPRODUCT.STOP_SHARE	Revokes authorization for a data portal.	ind_v5.1.2
  MENU.SHARE_EXPORT	Grants export permission for a data portal menu.	ind_v5.1.2
  MENU.SHARE_VIEW	Grants view permission for a data portal menu.	ind_v5.1.2
  MENU.SHARE_MANAGE_ALL_DATA	Grants permission to manage all data in a data portal menu.	ind_v5.1.2
  MENU.SHARE_MANAGE_OWN_DATA	Grants permission to manage own data in a data portal menu.	ind_v5.1.2
  MENU.SHARE_SUBMIT_DATA	Grants permission to submit data through a data portal menu.	ind_v5.1.2
  MENU.STOP_SHARE	Revokes authorization for a data portal menu.	ind_v5.1.2

• Event description: Events related to data portal authorization.

• Event body:

  Parameter	Type	Description
  schema	string	The event schema.
  header	event_header	The event header.
  eventId	string	The event ID.
  eventType	string	The event type.
  createTime	string	The creation timestamp of the event.
  organizationId	string	The ID of the event's organization.
  event	-	-
  operatorId	string	The operator's user_id, which uniquely identifies a user within a Quick BI organization.
  targetId	string	The ID of the target.
  targetName	string	The name of the target.
  targetType	string	The type of the target. Valid values: DATAPRODUCT: a data portal MENU: a data portal menu
  grantedId	string	The ID of the grantee.
  grantedType	string	The type of the grantee. Valid values: USER: a user ALLUSER: all members of the organization WORKSPACEUSER: all members of the workspace USERGROUP: a user group

  This event indicates that at [createTime], [operator] granted the grantee ([grantedId/grantedType]) permissions on the target ([targetId/targetName/targetType]).

• Example of an event body for data portal authorization:

{
  "schema": "1.0",
  "header": {
    "organizationId": "2fe4fbd8-588f-489a-b3e1-e92c7af083ea",
    "eventId": "637c2c83-6e12-465b-8dc9-e5864586cf24",
    "createTime": "1716433937829",
    "eventType": "DATAPRODUCT.SHARE_EDITOR"
  },
  "event": {
    "targetName": "untitled_202404111755_copy",
    "grantedId": "39735014-1eab-44ac-b94b-f0947990d6df",
    "targetId": "8c699d2e-a5f1-4d48-9dd1-e91e060f5894",
    "grantedType": "WORKSPACEUSER",
    "targetType": "DATAPRODUCT",
    "operatorId": "f1f4ab86b0fa44519e2fbe0a204675a1"
  }
}

Data consumption collaboration event API

This API reference applies to data consumption collaboration events, which are configured in an event listening task. To trigger and test these events, perform the corresponding business operations.