Team Events

Notice:

If there are multiple app subscribing to an event at the same time, there is no execution order between the app

If the parameter: async: false is configured, it will be executed serially first, and a result needs to be returned

Otherwise, the app will be executed asynchronously in parallel, and the execution result will be ignored

trigger_execute

Apps can subscribe to the following Team Events:

Item
Workspace
Filter
View
Board
WorkspaceTemplate

You can see the trigger example for example

Item

In Apps, you can subscribe to the following Team Item Events:

BeforeCreate: gei:proxima:item:beforeCreate
BeforeUpdate: gei:proxima:item:beforeUpdate
BeforeDelete: gei:proxima:item:beforeDelete
BeforeRevert: gei:proxima:item:beforeRevert
Created: gei:proxima:item:created
Updated: gei:proxima:item:updated
Deleted: gei:proxima:item:deleted

Each Event has different event parameters.

Item Before Create

An event with the name gei:proxima:item:beforeCreate is sent when before an item created

Payload

Name	Type	Description
event	String	The event name `gei:proxima:item:beforeCreate`
item	Item	The item the event is related to
actor	User	The user that has caused the event.
isClone	Boolean	Was it cloned from another item。 Yes or No

Response (Optional)

If you need to throw an error to the caller or return the modified item data, you can configure async: false and return the following data:

caution

If the application is not in production, but in staging or development, then async: false will not work, meaning the following return will not be effective.

Name	Type	required	Description
code	number	false	Error code
message	string	false	Error message
item	Item	false	The returned item data can be saved to the item information

Example

{
	"event": "gei:proxima:item:created",
	"isClone": false,
	"actor": {
		"createdAt": "2021-10-20T14: 08: 16.652Z",
		"updatedAt": "2021-12-22T12: 44: 13.613Z",
		"username": "osc-admin",
		"email": "osc-admin@oschina.cn",
		"enabled": true,
		"deleted": false,
		"nickname": "管理员",
		"language": "zh-CN",
		"role": {
			"createdAt": "2021-11-08T09: 12: 32.585Z",
			"updatedAt": "2021-12-26T04: 00: 09.098Z",
			"name": "superAdmin",
			"isRoot": true,
			"tag": "超级管理员",
			"isSystem": true,
			"objectId": "swvphORBnd"
		},
		"objectId": "jasPZZVVEQ"
	},
	"item": {
		"ancestors": [],
		"values": {
			"editor_intent_desc": [null],
			"editor_intent_target": [null],
			"priority": "90c529a1-8717-4a6b-b0e9-89de31a5b73b",
			"__screen_type": "create"
		},
		"name": "34",
		"workspace": {
			"__type": "Pointer",
			"className": "Workspace",
			"objectId": "RBSqxbkjEr"
		},
		"itemType": {
			"__type": "Pointer",
			"className": "ItemType",
			"objectId": "noJue4D20k"
		},
		"itemGroup": {
			"__type": "Pointer",
			"className": "ItemGroup",
			"objectId": "nFYKjPK8bP"
		},
		"createdAt": "2022-11-08T10: 41: 16.893Z",
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"key": "TEST_01-45",
		"status": {
			"__type": "Pointer",
			"className": "Status",
			"objectId": "1cGVyj2879"
		},
		"updatedAt": "2022-11-08T10: 41: 16.893Z",
	}
}

Item Before Update

An event with the name gei:proxima:item:beforeUpdate is sent when before an item updated

Payload

Name	Type	Description
event	String	The event name `gei:proxima:item:beforeUpdate`
item	Item	The item the event is related to
actor	User	The user that has caused the event.
originalItem	Item	The before update item the event is related to

Response (Optional)

If you need to throw an error to the caller or return the modified item data, you can configure async: false and return the following data:

caution

If the application is not in production, but in staging or development, then async: false will not work, meaning the following return will not be effective.

Name	Type	required	Description
code	number	false	Error code
message	string	false	Error message
item	Item	false	The returned item data can be saved to the item information

Example

{
	"event": "gei:proxima:item:beforeUpdate",
	"actor": {
		"createdAt": "2021-10-20T14: 08: 16.652Z",
		"updatedAt": "2021-12-22T12: 44: 13.613Z",
		"username": "osc-admin",
		"email": "osc-admin@oschina.cn",
		"enabled": true,
		"deleted": false,
		"nickname": "管理员",
		"language": "zh-CN",
		"role": {
			"createdAt": "2021-11-08T09: 12: 32.585Z",
			"updatedAt": "2021-12-26T04: 00: 09.098Z",
			"name": "superAdmin",
			"isRoot": true,
			"tag": "超级管理员",
			"isSystem": true,
			"objectId": "swvphORBnd"
		},
		"objectId": "jasPZZVVEQ"
	},
	"item": {
		"ancestors": [],
		"values": {
			"editor_intent_desc": [null],
			"editor_intent_target": [null],
			"priority": "90c529a1-8717-4a6b-b0e9-89de31a5b73b",
			"__screen_type": "create"
		},
		"name": "34",
		"workspace": {
			"__type": "Pointer",
			"className": "Workspace",
			"objectId": "RBSqxbkjEr"
		},
		"itemType": {
			"__type": "Pointer",
			"className": "ItemType",
			"objectId": "noJue4D20k"
		},
		"itemGroup": {
			"__type": "Pointer",
			"className": "ItemGroup",
			"objectId": "nFYKjPK8bP"
		},
		"createdAt": "2022-11-08T10: 41: 16.893Z",
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"key": "TEST_01-45",
		"status": {
			"__type": "Pointer",
			"className": "Status",
			"objectId": "1cGVyj2879"
		},
		"updatedAt": "2022-11-08T10: 41: 16.893Z",
		"objectId": "BpPZ2Tk5wS"
	},
    "originalItem": {
		"ancestors": [],
		"values": {
			"editor_intent_desc": [null],
			"editor_intent_target": [null],
			"priority": "90c529a1-8717-4a6b-b0e9-89de31a5b73b",
			"__screen_type": "create"
		},
		"name": "34",
		"workspace": {
			"__type": "Pointer",
			"className": "Workspace",
			"objectId": "RBSqxbkjEr"
		},
		"itemType": {
			"__type": "Pointer",
			"className": "ItemType",
			"objectId": "noJue4D20k"
		},
		"itemGroup": {
			"__type": "Pointer",
			"className": "ItemGroup",
			"objectId": "nFYKjPK8bP"
		},
		"createdAt": "2022-11-08T10: 41: 16.893Z",
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"key": "TEST_01-45",
		"status": {
			"__type": "Pointer",
			"className": "Status",
			"objectId": "1cGVyj2879"
		},
		"updatedAt": "2022-11-08T10: 41: 16.893Z",
		"objectId": "BpPZ2Tk5wS"
	}
}

Item Before Delete

An event with the name gei:proxima:item:beforeDelete is sent when before an item deleted

Payload

Name	Type	Description
event	String	The event name `gei:proxima:item:beforeDelete`
item	Item	The item the event is related to
actor	User	The user that has caused the event.
useMasterKey	Boolean	Whether the item is internally deleted， Yes or No。Internal deletion will skip some permission checks

Response (Optional)

If you need to throw an error to the caller, you can configure async: false and return the following data:

caution

If the application is not in production, but in staging or development, then async: false will not work, meaning the following return will not be effective.

Name	Type	Description
code	number	Error code
message	string	Error message

Example

{
	"event": "gei:proxima:item:beforeDelete",
	"useMasterKey": false,
	"actor": {
		"createdAt": "2021-10-20T14: 08: 16.652Z",
		"updatedAt": "2021-12-22T12: 44: 13.613Z",
		"username": "osc-admin",
		"email": "osc-admin@oschina.cn",
		"enabled": true,
		"deleted": false,
		"nickname": "管理员",
		"language": "zh-CN",
		"role": {
			"createdAt": "2021-11-08T09: 12: 32.585Z",
			"updatedAt": "2021-12-26T04: 00: 09.098Z",
			"name": "superAdmin",
			"isRoot": true,
			"tag": "超级管理员",
			"isSystem": true,
			"objectId": "swvphORBnd"
		},
		"objectId": "jasPZZVVEQ"
	},
	"item": {
		"ancestors": [],
		"values": {
			"editor_intent_desc": [null],
			"editor_intent_target": [null],
			"priority": "90c529a1-8717-4a6b-b0e9-89de31a5b73b",
			"__screen_type": "create"
		},
		"name": "34",
		"workspace": {
			"__type": "Pointer",
			"className": "Workspace",
			"objectId": "RBSqxbkjEr"
		},
		"itemType": {
			"__type": "Pointer",
			"className": "ItemType",
			"objectId": "noJue4D20k"
		},
		"itemGroup": {
			"__type": "Pointer",
			"className": "ItemGroup",
			"objectId": "nFYKjPK8bP"
		},
		"createdAt": "2022-11-08T10: 41: 16.893Z",
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"key": "TEST_01-45",
		"status": {
			"__type": "Pointer",
			"className": "Status",
			"objectId": "1cGVyj2879"
		},
		"updatedAt": "2022-11-08T10: 41: 16.893Z",
		"objectId": "BpPZ2Tk5wS"
	}
}

Item before reverted

Before an item is reverted, an event named gei:proxima:item:beforeRevert will be sent.

Payload

Name	Type	Description
event	String	The event name `gei:proxima:item:beforeRevert`
item	Item	The item the event is related to
actor	User	The user that has caused the event.

Response (Optional)

If you need to throw an error to the caller or return the modified item data, you can configure async: false and return the following data:

caution

If the application is not in production, but in staging or development, then async: false will not work, meaning the following return will not be effective.

Name	Type	required	Description
code	number	false	Error code
message	string	false	Error message
item	Item	false	The returned item data can be saved to the item information

Example

{
	"event": "gei:proxima:item:beforeRevert",
	"actor": {
		"createdAt": "2021-10-20T14: 08: 16.652Z",
		"updatedAt": "2021-12-22T12: 44: 13.613Z",
		"username": "osc-admin",
		"email": "osc-admin@oschina.cn",
		"enabled": true,
		"deleted": false,
		"nickname": "管理员",
		"language": "zh-CN",
		"role": {
			"createdAt": "2021-11-08T09: 12: 32.585Z",
			"updatedAt": "2021-12-26T04: 00: 09.098Z",
			"name": "superAdmin",
			"isRoot": true,
			"tag": "超级管理员",
			"isSystem": true,
			"objectId": "swvphORBnd"
		},
		"objectId": "jasPZZVVEQ"
	},
	"item": {
		"ancestors": [],
		"values": {
			"editor_intent_desc": [null],
			"editor_intent_target": [null],
			"priority": "90c529a1-8717-4a6b-b0e9-89de31a5b73b",
			"__screen_type": "create"
		},
		"name": "34",
		"workspace": {
			"__type": "Pointer",
			"className": "Workspace",
			"objectId": "RBSqxbkjEr"
		},
		"itemType": {
			"__type": "Pointer",
			"className": "ItemType",
			"objectId": "noJue4D20k"
		},
		"itemGroup": {
			"__type": "Pointer",
			"className": "ItemGroup",
			"objectId": "nFYKjPK8bP"
		},
		"createdAt": "2022-11-08T10: 41: 16.893Z",
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"key": "TEST_01-45",
		"status": {
			"__type": "Pointer",
			"className": "Status",
			"objectId": "1cGVyj2879"
		},
		"updatedAt": "2022-11-08T10: 41: 16.893Z",
		"objectId": "BpPZ2Tk5wS"
	}
}

Item Created

An event with the name gei:proxima:item:created is sent when an item is created

Payload

Name	Type	Description
event	String	The event name `gei:proxima:item:created`
item	Item	The item the event is related to
actor	User	The user that has caused the event.

Example

{
	"event": "gei:proxima:item:created",
	"actor": {
		"createdAt": "2021-10-20T14: 08: 16.652Z",
		"updatedAt": "2021-12-22T12: 44: 13.613Z",
		"username": "osc-admin",
		"email": "osc-admin@oschina.cn",
		"enabled": true,
		"deleted": false,
		"nickname": "管理员",
		"language": "zh-CN",
		"role": {
			"createdAt": "2021-11-08T09: 12: 32.585Z",
			"updatedAt": "2021-12-26T04: 00: 09.098Z",
			"name": "superAdmin",
			"isRoot": true,
			"tag": "超级管理员",
			"isSystem": true,
			"objectId": "swvphORBnd"
		},
		"objectId": "jasPZZVVEQ"
	},
	"item": {
		"ancestors": [],
		"values": {
			"editor_intent_desc": [null],
			"editor_intent_target": [null],
			"priority": "90c529a1-8717-4a6b-b0e9-89de31a5b73b",
			"__screen_type": "create"
		},
		"name": "34",
		"workspace": {
			"__type": "Pointer",
			"className": "Workspace",
			"objectId": "RBSqxbkjEr"
		},
		"itemType": {
			"__type": "Pointer",
			"className": "ItemType",
			"objectId": "noJue4D20k"
		},
		"itemGroup": {
			"__type": "Pointer",
			"className": "ItemGroup",
			"objectId": "nFYKjPK8bP"
		},
		"createdAt": "2022-11-08T10: 41: 16.893Z",
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"key": "TEST_01-45",
		"status": {
			"__type": "Pointer",
			"className": "Status",
			"objectId": "1cGVyj2879"
		},
		"updatedAt": "2022-11-08T10: 41: 16.893Z",
		"objectId": "BpPZ2Tk5wS"
	}
}

Item Updated

An event with the name gei:proxima:item:updated is sent when an item is updated

Payload

Name	Type	Description
event	String	The event name `gei:proxima:item:updated`
item	Item	The item the event is related to
originalItem	Item	The before update item the event is related to
actor	User	The user that has caused the event.

Example

{
	"event": "gei:proxima:item:updated",
	"actor": {
		"createdAt": "2021-10-20T14: 08: 16.652Z",
		"updatedAt": "2021-12-22T12: 44: 13.613Z",
		"username": "osc-admin",
		"email": "osc-admin@oschina.cn",
		"enabled": true,
		"deleted": false,
		"nickname": "管理员",
		"language": "zh-CN",
		"role": {
			"createdAt": "2021-11-08T09: 12: 32.585Z",
			"updatedAt": "2021-12-26T04: 00: 09.098Z",
			"name": "superAdmin",
			"isRoot": true,
			"tag": "超级管理员",
			"isSystem": true,
			"objectId": "swvphORBnd"
		},
		"objectId": "jasPZZVVEQ"
	},
	"item": {
		"ancestors": [],
		"values": {
			"editor_intent_desc": [null],
			"editor_intent_target": [null],
			"priority": "90c529a1-8717-4a6b-b0e9-89de31a5b73b",
			"__screen_type": "create"
		},
		"name": "34",
		"workspace": {
			"__type": "Pointer",
			"className": "Workspace",
			"objectId": "RBSqxbkjEr"
		},
		"itemType": {
			"__type": "Pointer",
			"className": "ItemType",
			"objectId": "noJue4D20k"
		},
		"itemGroup": {
			"__type": "Pointer",
			"className": "ItemGroup",
			"objectId": "nFYKjPK8bP"
		},
		"createdAt": "2022-11-08T10: 41: 16.893Z",
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"key": "TEST_01-45",
		"status": {
			"__type": "Pointer",
			"className": "Status",
			"objectId": "1cGVyj2879"
		},
		"updatedAt": "2022-11-08T10: 41: 16.893Z",
		"objectId": "BpPZ2Tk5wS"
	}
}

Item deleted

When an item is deleted, an event named gei:proxima:item:deleted will be sent.

Parameters

Parameter	Type	Description
event	String	Event name `gei:proxima:item:deleted`
item	Item	The item the event is related to
actor	User	The user that has caused the event.
useMasterKey	Boolean	Whether the item was deleted internally, true or false. Internal deletion will skip some permission checks

Example

{
	"event": "gei:proxima:item:deleted",
	"useMasterKey": false,
	"actor": {
		"createdAt": "2021-10-20T14: 08: 16.652Z",
		"updatedAt": "2021-12-22T12: 44: 13.613Z",
		"username": "osc-admin",
		"email": "osc-admin@oschina.cn",
		"enabled": true,
		"deleted": false,
		"nickname": "管理员",
		"language": "zh-CN",
		"role": {
			"createdAt": "2021-11-08T09: 12: 32.585Z",
			"updatedAt": "2021-12-26T04: 00: 09.098Z",
			"name": "superAdmin",
			"isRoot": true,
			"tag": "超级管理员",
			"isSystem": true,
			"objectId": "swvphORBnd"
		},
		"objectId": "jasPZZVVEQ"
	},
	"item": {
		"ancestors": [],
		"values": {
			"editor_intent_desc": [null],
			"editor_intent_target": [null],
			"priority": "90c529a1-8717-4a6b-b0e9-89de31a5b73b",
			"__screen_type": "create"
		},
		"name": "34",
		"workspace": {
			"__type": "Pointer",
			"className": "Workspace",
			"objectId": "RBSqxbkjEr"
		},
		"itemType": {
			"__type": "Pointer",
			"className": "ItemType",
			"objectId": "noJue4D20k"
		},
		"itemGroup": {
			"__type": "Pointer",
			"className": "ItemGroup",
			"objectId": "nFYKjPK8bP"
		},
		"createdAt": "2022-11-08T10: 41: 16.893Z",
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"key": "TEST_01-45",
		"status": {
			"__type": "Pointer",
			"className": "Status",
			"objectId": "1cGVyj2879"
		},
		"updatedAt": "2022-11-08T10: 41: 16.893Z",
		"objectId": "BpPZ2Tk5wS"
	}
}

IQL Events

Within Apps, you can subscribe to the following Team IQL events:

Before IQL Execution Event: gei:proxima:iql:beforeExecute

Before IQL Execution Event

Before an IQL query is executed, an event named gei:proxima:iql:beforeExecute is sent. Here, you have the opportunity to modify the IQL statement. IQL queries cover various scenarios such as lists, boards, calendars, reports, and more.

Parameters

Parameter Name	Type	Description
event	String	Event name: `gei:proxima:iql:beforeExecute`
iql	String	Relevant IQL for the event
actor	User	User triggering the event
itemRoles	String[]	Item roles possessed by the user, useful for item visibility

Response (Optional)

When you need to override the IQL, you can configure the plugin to execute synchronously with async: false and return the following data for IQL override:

Parameter Name	Type	Description
iql	String	Rewritten IQL

Parameter Example

{
    "event": "gei:proxima:iql:beforeExecute",
    "actor": {
        "createdAt": "2021-10-20T14: 08: 16.652Z",
        "updatedAt": "2021-12-22T12: 44: 13.613Z",
        "username": "osc-admin",
        "email": "osc-admin@oschina.cn",
        "enabled": true,
        "deleted": false,
        "nickname": "Administrator",
        "language": "zh-CN",
        "role": {
            "createdAt": "2021-11-08T09: 12: 32.585Z",
            "updatedAt": "2021-12-26T04: 00: 09.098Z",
            "name": "superAdmin",
            "isRoot": true,
            "tag": "Super Administrator",
            "isSystem": true,
            "objectId": "swvphORBnd"
        },
        "objectId": "jasPZZVVEQ"
    },
    "iql": "Space='Requirement Space' and Status in ['Completed','Rejected']",
	"itemRoles": [
		"CYCdnCHjEp",
		"O3v02C7wxJ"
	]
}

Response Example

{
	"iql": "Space='Requirement Space' and Status in ['Completed','Rejected'] and Priority in ['High','Medium']"
}

Workspace

In Apps, you can subscribe to the following Team Workspace Events:

Created: gei:proxima:workspace:created
Updated: gei:proxima:workspace:updated
Deleted: gei:proxima:workspace:deleted

Workspace Created

An event with the name gei:proxima:workspace:created is sent when the workspace is created.

Payload

Name	Type	Description
event	String	The event name `gei:proxima:workspace:created`
workspace	Workspace	The workspace the event is related to
actor	User	The user that has caused the event.

Example

{
	"event": "gei:proxima:workspace:created",
	"actor": {
		"createdAt": "2021-10-20T14: 08: 16.652Z",
		"updatedAt": "2021-12-22T12: 44: 13.613Z",
		"username": "osc-admin",
		"email": "osc-admin@oschina.cn",
		"enabled": true,
		"deleted": false,
		"nickname": "管理员",
		"language": "zh-CN",
		"role": {
			"createdAt": "2021-11-08T09: 12: 32.585Z",
			"updatedAt": "2021-12-26T04: 00: 09.098Z",
			"name": "superAdmin",
			"isRoot": true,
			"tag": "超级管理员",
			"isSystem": true,
			"objectId": "swvphORBnd"
		},
		"objectId": "jasPZZVVEQ"
	},
	"workspace": {
		"createdAt": "2022-11-09T06:25:24.450Z",
		"updatedAt": "2022-11-09T06:25:27.540Z",
		"name": "需求空间test1",
		"key": "XJKJ_TEST_1",
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"lead": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"icon": "/icons/TeamIcon.svg",
		"updatedBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"objectId": "HV4g5fbg7C"
	}
}

Workspace Updated

An event with the name gei:proxima:workspace:updated is sent when the workspace is updated.

Payload

Name	Type	Description
event	String	The event name `gei:proxima:workspace:updated`
workspace	Workspace	The workspace the event is related to
originalWorkspace	Workspace	The before update workspace the event is related to
actor	User	The user that has caused the event.

Example

{
	"event": "gei:proxima:workspace:updated",
	"actor": {
		"createdAt": "2021-10-20T14: 08: 16.652Z",
		"updatedAt": "2021-12-22T12: 44: 13.613Z",
		"username": "osc-admin",
		"email": "osc-admin@oschina.cn",
		"enabled": true,
		"deleted": false,
		"nickname": "管理员",
		"language": "zh-CN",
		"role": {
			"createdAt": "2021-11-08T09: 12: 32.585Z",
			"updatedAt": "2021-12-26T04: 00: 09.098Z",
			"name": "superAdmin",
			"isRoot": true,
			"tag": "超级管理员",
			"isSystem": true,
			"objectId": "swvphORBnd"
		},
		"objectId": "jasPZZVVEQ"
	},
	"workspace": {
		"createdAt": "2022-11-09T06:25:24.450Z",
		"updatedAt": "2022-11-09T06:25:27.540Z",
		"name": "需求空间test1",
		"key": "XJKJ_TEST_1",
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"lead": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"icon": "/icons/TeamIcon.svg",
		"updatedBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"objectId": "HV4g5fbg7C"
	},
	"originalWorkspace": {
		"createdAt": "2022-11-09T06:25:24.450Z",
		"updatedAt": "2022-11-09T06:25:27.540Z",
		"name": "需求空间test1",
		"key": "XJKJ_TEST_1",
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"lead": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"icon": "/icons/TeamIcon.svg",
		"updatedBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"objectId": "HV4g5fbg7C"
	}
}

Workspace Deleted

An event with the name gei:proxima:workspace:deleted is sent when the workspace is deleted.

Payload

Name	Type	Description
event	String	The event name `gei:proxima:workspace:deleted`
workspace	Workspace	The workspace the event is related to
actor	User	The user that has caused the event.

Example

{
	"event": "gei:proxima:workspace:deleted",
	"actor": {
		"createdAt": "2021-10-20T14: 08: 16.652Z",
		"updatedAt": "2021-12-22T12: 44: 13.613Z",
		"username": "osc-admin",
		"email": "osc-admin@oschina.cn",
		"enabled": true,
		"deleted": false,
		"nickname": "管理员",
		"language": "zh-CN",
		"role": {
			"createdAt": "2021-11-08T09: 12: 32.585Z",
			"updatedAt": "2021-12-26T04: 00: 09.098Z",
			"name": "superAdmin",
			"isRoot": true,
			"tag": "超级管理员",
			"isSystem": true,
			"objectId": "swvphORBnd"
		},
		"objectId": "jasPZZVVEQ"
	},
	"workspace": {
		"createdAt": "2022-11-09T06:25:24.450Z",
		"updatedAt": "2022-11-09T06:25:27.540Z",
		"name": "需求空间test1",
		"key": "XJKJ_TEST_1",
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"lead": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"icon": "/icons/TeamIcon.svg",
		"updatedBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"objectId": "HV4g5fbg7C"
	}
}

Filter

In Apps, you can subscribe to the following Team Filter Events:

Before Delete: gei:proxima:filter:beforeDelete

Filter Before Delete

An event with the name gei:proxima:filter:beforeDelete is sent before an Filter deleted

Payload

Name	Type	Description
event	String	The event name `gei:proxima:filter:beforeDelete`
filter	Filter	The filter the event is related to
actor	User	The user that has caused the event.

Response (Optional)

If you need to throw an error to the caller, you can configure async: false and return the following data:

caution

If the application is not in production, but in staging or development, then async: false will not work, meaning the following return will not be effective.

Name	Type	Description
code	number	Error code
message	string	Error message

Example

Payload

{
	"event": "gei:proxima:filter:beforeDelete",
	"actor": {
		"createdAt": "2021-10-20T14: 08: 16.652Z",
		"updatedAt": "2021-12-22T12: 44: 13.613Z",
		"username": "osc-admin",
		"email": "osc-admin@oschina.cn",
		"enabled": true,
		"deleted": false,
		"nickname": "管理员",
		"language": "zh-CN",
		"role": {
			"createdAt": "2021-11-08T09: 12: 32.585Z",
			"updatedAt": "2021-12-26T04: 00: 09.098Z",
			"name": "superAdmin",
			"isRoot": true,
			"tag": "超级管理员",
			"isSystem": true,
			"objectId": "swvphORBnd"
		},
		"objectId": "jasPZZVVEQ"
	},
	"filter": {
		"createdAt": "2022-11-09T06:20:48.783Z",
		"updatedAt": "2022-11-09T06:20:48.783Z",
		"expression": "'所属空间' in [\"需求空间\"]",
		"name": "测试筛选器",
		"global": true,
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"objectId": "uuoUoRWmMj"
	}
}

View

You can subscribe to the following Team View events:

Before creation: gei:proxima:view:beforeCreate
Before update: gei:proxima:view:beforeUpdate
After deletion: gei:proxima:view:deleted

View Before Create

An event with the name gei:proxima:view:beforeCreate is sent before an View created.

Payload

Name	Type	Description
event	String	The event name `gei:proxima:view:beforeCreate`
view	View	The view the event is related to
actor	User	The user that has caused the event.

Response (Optional)

If you need to throw an error to the caller, you can configure async: false and return the following data:

caution

If the application is not in production, but in staging or development, then async: false will not work, meaning the following return will not be effective.

Name	Type	Description
code	number	Error code
message	string	Error message

Example

{
    "event": "gei:proxima:view:beforeCreate",
    "actor": {
        "createdAt": "2021-10-20T14: 08: 16.652Z",
    		"updatedAt": "2021-12-22T12: 44: 13.613Z",
    		"username": "osc-admin",
    		"email": "osc-admin@oschina.cn",
    		"enabled": true,
    		"deleted": false,
    		"nickname": "管理员",
    		"language": "zh-CN",
    		"role": {
    			"createdAt": "2021-11-08T09: 12: 32.585Z",
    			"updatedAt": "2021-12-26T04: 00: 09.098Z",
    			"name": "superAdmin",
    			"isRoot": true,
    			"tag": "超级管理员",
    			"isSystem": true,
    			"objectId": "swvphORBnd"
    		},
    		"objectId": "jasPZZVVEQ"
    },
    "view": {
        "permission": {
            "category": "private",
            "shareList": []
        },
        "component": "Default",
        "name": "view-demo",
        "createdBy": {
            "__type": "Pointer",
            "className": "_User",
            "objectId": "jasPZZVVEQ"
        }
    },
}

View Before Update

An event with the name gei:proxima:view:beforeUpdate is sent before an View updated.

Payload

Name	Type	Description
event	String	The event name `gei:proxima:view:beforeUpdate`
view	View	The view the event is related to
originalView	View	The before update view the event is related to
actor	User	The user that has caused the event.

Response (Optional)

If you need to throw an error to the caller, you can configure async: false and return the following data:

caution

If the application is not in production, but in staging or development, then async: false will not work, meaning the following return will not be effective.

Name	Type	Description
code	number	Error code
message	string	Error message

Example

{
    "event": "gei:proxima:view:beforeUpdate",
    "actor": {
        "createdAt": "2021-10-20T14: 08: 16.652Z",
    		"updatedAt": "2021-12-22T12: 44: 13.613Z",
    		"username": "osc-admin",
    		"email": "osc-admin@oschina.cn",
    		"enabled": true,
    		"deleted": false,
    		"nickname": "管理员",
    		"language": "zh-CN",
    		"role": {
    			"createdAt": "2021-11-08T09: 12: 32.585Z",
    			"updatedAt": "2021-12-26T04: 00: 09.098Z",
    			"name": "superAdmin",
    			"isRoot": true,
    			"tag": "超级管理员",
    			"isSystem": true,
    			"objectId": "swvphORBnd"
    		},
    		"objectId": "jasPZZVVEQ"
    },
    "view": {
        "permission": {
            "category": "private",
            "shareList": []
        },
        "component": "Default",
        "name": "view-demo",
        "createdBy": {
            "__type": "Pointer",
            "className": "_User",
            "objectId": "jasPZZVVEQ"
        }
    },
}

View After Delete

An event with the name gei:proxima:view:deleted is sent before an View deleted.

Payload

Name	Type	Description
event	String	The event name `gei:proxima:view:deleted`
view	View	The view the event is related to
actor	User	The user that has caused the event.

Example

{
    "event": "gei:proxima:view:deleted",
    "actor": {
        "createdAt": "2021-10-20T14: 08: 16.652Z",
    		"updatedAt": "2021-12-22T12: 44: 13.613Z",
    		"username": "osc-admin",
    		"email": "osc-admin@oschina.cn",
    		"enabled": true,
    		"deleted": false,
    		"nickname": "管理员",
    		"language": "zh-CN",
    		"role": {
    			"createdAt": "2021-11-08T09: 12: 32.585Z",
    			"updatedAt": "2021-12-26T04: 00: 09.098Z",
    			"name": "superAdmin",
    			"isRoot": true,
    			"tag": "超级管理员",
    			"isSystem": true,
    			"objectId": "swvphORBnd"
    		},
    		"objectId": "jasPZZVVEQ"
    },
    "view": {
        "permission": {
            "category": "private",
            "shareList": []
        },
        "component": "Default",
        "name": "view-demo",
        "createdBy": {
            "__type": "Pointer",
            "className": "_User",
            "objectId": "jasPZZVVEQ"
        }
    },
}

Board

You can subscribe to the following Team Board events:

Before creation: gei:proxima:board:beforeCreate
Before update: gei:proxima:board:beforeUpdate
After deletion: gei:proxima:board:deleted

Board Before Create

An event with the name gei:proxima:board:beforeCreate is sent before an Board created.

Payload

Name	Type	Description
event	String	The event name `gei:proxima:board:beforeCreate`
board	Board	The board the event is related to
actor	User	The user that has caused the event.

Response (Optional)

If you need to throw an error to the caller, you can configure async: false and return the following data:

caution

If the application is not in production, but in staging or development, then async: false will not work, meaning the following return will not be effective.

Name	Type	Description
code	number	Error code
message	string	Error message

Example

{
    "event": "gei:proxima:board:beforeCreate",
    "actor": {
        "createdAt": "2021-10-20T14: 08: 16.652Z",
    		"updatedAt": "2021-12-22T12: 44: 13.613Z",
    		"username": "osc-admin",
    		"email": "osc-admin@oschina.cn",
    		"enabled": true,
    		"deleted": false,
    		"nickname": "管理员",
    		"language": "zh-CN",
    		"role": {
    			"createdAt": "2021-11-08T09: 12: 32.585Z",
    			"updatedAt": "2021-12-26T04: 00: 09.098Z",
    			"name": "superAdmin",
    			"isRoot": true,
    			"tag": "超级管理员",
    			"isSystem": true,
    			"objectId": "swvphORBnd"
    		},
    		"objectId": "jasPZZVVEQ"
    },
    "board": {
        "createdAt": "2023-12-21T09:06:46.389Z",
        "updatedAt": "2024-01-03T02:55:28.571Z",
        "name": "All items",
        "key": "8ecf5af6-be57-49c6-8335-9807bc9d528f",
        "workspace": {
            "__type": "Pointer",
            "className": "Workspace",
            "objectId": "UZCwfVUg7G"
        },
        "createdBy": {
            "__type": "Pointer",
            "className": "_User",
            "objectId": "jasPZZVVEQ"
        },
        "updatedBy": {
            "__type": "Pointer",
            "className": "_User",
            "objectId": "jasPZZVVEQ"
        },
        "filterSource": "inWorkspace",
        "icon": "/icons/Panel1",
        "objectId": "adHo7mvrCB"
    },
}

Board Before Update

An event with the name gei:proxima:board:beforeUpdate is sent before an Board updated.

Payload

Name	Type	Description
event	String	The event name `gei:proxima:board:beforeUpdate`
board	Board	The board the event is related to
originalBoard	Board	The before update board the event is related to
actor	User	The user that has caused the event.

Response (Optional)

If you need to throw an error to the caller, you can configure async: false and return the following data:

caution

If the application is not in production, but in staging or development, then async: false will not work, meaning the following return will not be effective.

Name	Type	Description
code	number	Error code
message	string	Error message

Example

{
    "event": "gei:proxima:board:beforeUpdate",
    "actor": {
        "createdAt": "2021-10-20T14: 08: 16.652Z",
    		"updatedAt": "2021-12-22T12: 44: 13.613Z",
    		"username": "osc-admin",
    		"email": "osc-admin@oschina.cn",
    		"enabled": true,
    		"deleted": false,
    		"nickname": "管理员",
    		"language": "zh-CN",
    		"role": {
    			"createdAt": "2021-11-08T09: 12: 32.585Z",
    			"updatedAt": "2021-12-26T04: 00: 09.098Z",
    			"name": "superAdmin",
    			"isRoot": true,
    			"tag": "超级管理员",
    			"isSystem": true,
    			"objectId": "swvphORBnd"
    		},
    		"objectId": "jasPZZVVEQ"
    },
    "board": {
        "createdAt": "2023-12-21T09:06:46.389Z",
        "updatedAt": "2024-01-03T02:55:28.571Z",
        "name": "All items",
        "key": "8ecf5af6-be57-49c6-8335-9807bc9d528f",
        "workspace": {
            "__type": "Pointer",
            "className": "Workspace",
            "objectId": "UZCwfVUg7G"
        },
        "createdBy": {
            "__type": "Pointer",
            "className": "_User",
            "objectId": "jasPZZVVEQ"
        },
        "updatedBy": {
            "__type": "Pointer",
            "className": "_User",
            "objectId": "jasPZZVVEQ"
        },
        "filterSource": "inWorkspace",
        "icon": "/icons/Panel1",
        "objectId": "adHo7mvrCB"
    },
}

Board After Delete

An event with the name gei:proxima:board:deleted is sent before an Board deleted.

Payload

Name	Type	Description
event	String	The event name `gei:proxima:board:deleted`
board	Board	The board the event is related to
actor	User	The user that has caused the event.

Example

{
    "event": "gei:proxima:board:deleted",
    "actor": {
        "createdAt": "2021-10-20T14: 08: 16.652Z",
    		"updatedAt": "2021-12-22T12: 44: 13.613Z",
    		"username": "osc-admin",
    		"email": "osc-admin@oschina.cn",
    		"enabled": true,
    		"deleted": false,
    		"nickname": "管理员",
    		"language": "zh-CN",
    		"role": {
    			"createdAt": "2021-11-08T09: 12: 32.585Z",
    			"updatedAt": "2021-12-26T04: 00: 09.098Z",
    			"name": "superAdmin",
    			"isRoot": true,
    			"tag": "超级管理员",
    			"isSystem": true,
    			"objectId": "swvphORBnd"
    		},
    		"objectId": "jasPZZVVEQ"
    },
    "board": {
        "createdAt": "2023-12-21T09:06:46.389Z",
        "updatedAt": "2024-01-03T02:55:28.571Z",
        "name": "All items",
        "key": "8ecf5af6-be57-49c6-8335-9807bc9d528f",
        "workspace": {
            "__type": "Pointer",
            "className": "Workspace",
            "objectId": "UZCwfVUg7G"
        },
        "createdBy": {
            "__type": "Pointer",
            "className": "_User",
            "objectId": "jasPZZVVEQ"
        },
        "updatedBy": {
            "__type": "Pointer",
            "className": "_User",
            "objectId": "jasPZZVVEQ"
        },
        "filterSource": "inWorkspace",
        "icon": "/icons/Panel1",
        "objectId": "adHo7mvrCB"
    },
}

WorkspaceTemplate

You can subscribe to the following Team WorkspaceTemplate events:

After creation: gei:proxima:workspaceTemplate:created
After update: gei:proxima:workspaceTemplate:updated
After deletion: gei:proxima:workspaceTemplate:deleted

WorkspaceTemplate After Create

An event with the name gei:proxima:workspaceTemplate:created is sent after an workspaceTemplate created.

Payload

Name	Type	Description
event	String	The event name `gei:proxima:workspaceTemplate:created`
workspaceTemplate	WorkspaceTemplate	The workspaceTemplate the event is related to
actor	User	The user that has caused the event.

Example

{
    "event": "gei:proxima:workspaceTemplate:created",
    "actor": {
        "createdAt": "2021-10-20T14: 08: 16.652Z",
    		"updatedAt": "2021-12-22T12: 44: 13.613Z",
    		"username": "osc-admin",
    		"email": "osc-admin@oschina.cn",
    		"enabled": true,
    		"deleted": false,
    		"nickname": "管理员",
    		"language": "zh-CN",
    		"role": {
    			"createdAt": "2021-11-08T09: 12: 32.585Z",
    			"updatedAt": "2021-12-26T04: 00: 09.098Z",
    			"name": "superAdmin",
    			"isRoot": true,
    			"tag": "超级管理员",
    			"isSystem": true,
    			"objectId": "swvphORBnd"
    		},
    		"objectId": "jasPZZVVEQ"
    },
    "workspaceTemplate": {
        "createdAt": "2023-12-21T09:06:46.389Z",
        "updatedAt": "2024-01-03T02:55:28.571Z",
        "name": "Workspace Template",
        "workspace": {
          "objectId": "UZCwfVUg7G"
        },
        "itemTypeScheme": {
          "objectId": "UZCwfVUg7G"
        },
        "itemTypeScreenScheme": {
          "objectId": "UZCwfVUg7G"
        },
        "workflowScheme": {
          "objectId": "UZCwfVUg7G"
        },
    },
}

WorkspaceTemplate After Update

An event with the name gei:proxima:workspaceTemplate:updated is sent after an workspaceTemplate updated.

Payload

Name	Type	Description
event	String	The event name `gei:proxima:workspaceTemplate:updated`
workspaceTemplate	WorkspaceTemplate	The workspaceTemplate the event is related to
originalWorkspaceTemplate	WorkspaceTemplate	The before update workspaceTemplate the event is related to
actor	User	The user that has caused the event.

Example

{
    "event": "gei:proxima:workspaceTemplate:updated",
    "actor": {
        "createdAt": "2021-10-20T14: 08: 16.652Z",
    		"updatedAt": "2021-12-22T12: 44: 13.613Z",
    		"username": "osc-admin",
    		"email": "osc-admin@oschina.cn",
    		"enabled": true,
    		"deleted": false,
    		"nickname": "管理员",
    		"language": "zh-CN",
    		"role": {
    			"createdAt": "2021-11-08T09: 12: 32.585Z",
    			"updatedAt": "2021-12-26T04: 00: 09.098Z",
    			"name": "superAdmin",
    			"isRoot": true,
    			"tag": "超级管理员",
    			"isSystem": true,
    			"objectId": "swvphORBnd"
    		},
    		"objectId": "jasPZZVVEQ"
    },
    "workspaceTemplate": {
        "createdAt": "2023-12-21T09:06:46.389Z",
        "updatedAt": "2024-01-03T02:55:28.571Z",
        "name": "Workspace Template",
        "workspace": {
          "objectId": "UZCwfVUg7G"
        },
        "itemTypeScheme": {
          "objectId": "UZCwfVUg7G"
        },
        "itemTypeScreenScheme": {
          "objectId": "UZCwfVUg7G"
        },
        "workflowScheme": {
          "objectId": "UZCwfVUg7G"
        },
    },
}

WorkspaceTemplate After Delete

An event with the name gei:proxima:workspaceTemplate:deleted is sent after an workspaceTemplate deleted.

Payload

Name	Type	Description
event	String	The event name `gei:proxima:workspaceTemplate:deleted`
workspaceTemplate	WorkspaceTemplate	The workspaceTemplate the event is related to
actor	User	The user that has caused the event.

Example

{
    "event": "gei:proxima:workspaceTemplate:deleted",
    "actor": {
        "createdAt": "2021-10-20T14: 08: 16.652Z",
    		"updatedAt": "2021-12-22T12: 44: 13.613Z",
    		"username": "osc-admin",
    		"email": "osc-admin@oschina.cn",
    		"enabled": true,
    		"deleted": false,
    		"nickname": "管理员",
    		"language": "zh-CN",
    		"role": {
    			"createdAt": "2021-11-08T09: 12: 32.585Z",
    			"updatedAt": "2021-12-26T04: 00: 09.098Z",
    			"name": "superAdmin",
    			"isRoot": true,
    			"tag": "超级管理员",
    			"isSystem": true,
    			"objectId": "swvphORBnd"
    		},
    		"objectId": "jasPZZVVEQ"
    },
    "workspaceTemplate": {
        "createdAt": "2023-12-21T09:06:46.389Z",
        "updatedAt": "2024-01-03T02:55:28.571Z",
        "name": "Workspace Template",
        "workspace": {
          "objectId": "UZCwfVUg7G"
        },
        "itemTypeScheme": {
          "objectId": "UZCwfVUg7G"
        },
        "itemTypeScreenScheme": {
          "objectId": "UZCwfVUg7G"
        },
        "workflowScheme": {
          "objectId": "UZCwfVUg7G"
        },
    },
}

BaseLineItems

You can subscribe to the following Team baseline item events:

After creation: gei:proxima:baseLineItems:created

After creating a baseline item

After creating a baseline item, an event named ·gei:proxima:baseLineItems:created· will be sent.

Payload

Name	Type	Description
event	String	The event name `gei:proxima:baseLineItems:created`
baseLineItems	BaseLineItem[]	The baseline items the event is related to
actor	User	The user that has caused the event.

Example

{
	"event": "gei:proxima:baseLineItems:created",
	"actor": {
		"createdAt": "2021-10-20T14: 08: 16.652Z",
		"updatedAt": "2021-12-22T12: 44: 13.613Z",
		"username": "osc-admin",
		"email": "osc-admin@oschina.cn",
		"enabled": true,
		"deleted": false,
		"nickname": "管理员",
		"language": "zh-CN",
		"role": {
			"createdAt": "2021-11-08T09: 12: 32.585Z",
			"updatedAt": "2021-12-26T04: 00: 09.098Z",
			"name": "superAdmin",
			"isRoot": true,
			"tag": "超级管理员",
			"isSystem": true,
			"objectId": "swvphORBnd"
		},
		"objectId": "jasPZZVVEQ"
	},
	"baseLineItems": [{
		"objectId": "0PDMY4mPiN",
		"itemId": "pEEC1GclyB",
		"ancestors": [],
		"values": {
			"editor_intent_desc": [null],
			"editor_intent_target": [null],
			"priority": "90c529a1-8717-4a6b-b0e9-89de31a5b73b",
			"__screen_type": "create"
		},
		"name": "34",
		"workspace": {
			"__type": "Pointer",
			"className": "Workspace",
			"objectId": "RBSqxbkjEr"
		},
		"itemType": {
			"__type": "Pointer",
			"className": "ItemType",
			"objectId": "noJue4D20k"
		},
		"createdAt": "2022-11-08T10: 41: 16.893Z",
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"key": "TEST_01-45",
		"status": {
			"__type": "Pointer",
			"className": "Status",
			"objectId": "1cGVyj2879"
		},
		"updatedAt": "2022-11-08T10: 41: 16.893Z",
	}]
}

Item​

Item Before Create​

Payload​

Response (Optional)​

Example​

Item Before Update​

Payload​

Response (Optional)​

Example​

Item Before Delete​

Payload​

Response (Optional)​

Example​

Item before reverted​

Payload​

Response (Optional)​

Example​

Item Created​

Payload​

Example​

Item Updated​

Payload​

Example​

Item deleted​

Parameters​

Example​

IQL Events​

Before IQL Execution Event​

Parameters​

Response (Optional)​

Parameter Example​

Response Example​

Workspace​

Workspace Created​

Payload​

Example​

Workspace Updated​

Payload​

Example​

Workspace Deleted​

Payload​

Example​

Filter​

Filter Before Delete​

Payload​

Response (Optional)​

Example​

View​

View Before Create​

Payload​

Response (Optional)​

Example​

View Before Update​

Payload​

Response (Optional)​

Example​

View After Delete​

Payload​

Example​

Board​

Board Before Create​

Payload​

Response (Optional)​

Example​

Board Before Update​

Payload​

Response (Optional)​

Example​

Board After Delete​

Payload​

Example​

WorkspaceTemplate​

WorkspaceTemplate After Create​

Payload​

Example​

WorkspaceTemplate After Update​

Payload​

Example​

WorkspaceTemplate After Delete​

Payload​

Item

Item Before Create

Payload

Response (Optional)

Example

Item Before Update

Payload

Response (Optional)

Example

Item Before Delete

Payload

Response (Optional)

Example

Item before reverted

Payload

Response (Optional)

Example

Item Created

Payload

Example

Item Updated

Payload

Example

Item deleted

Parameters

Example

IQL Events

Before IQL Execution Event

Parameters

Response (Optional)

Parameter Example

Response Example

Workspace

Workspace Created

Payload

Example

Workspace Updated

Payload

Example

Workspace Deleted

Payload

Example

Filter

Filter Before Delete

Payload

Response (Optional)

Example

View

View Before Create

Payload

Response (Optional)

Example

View Before Update

Payload

Response (Optional)

Example

View After Delete

Payload

Example

Board

Board Before Create

Payload

Response (Optional)

Example

Board Before Update

Payload

Response (Optional)

Example

Board After Delete

Payload

Example

WorkspaceTemplate

WorkspaceTemplate After Create

Payload

Example

WorkspaceTemplate After Update

Payload

Example

WorkspaceTemplate After Delete

Payload