Version: v5.1

Notification Service events

Overview#

In the Notification Service, event triggers are set up which listen to events and determine when to send a notification. This section provides a list of the events which are available to use.

Resource events#

Events are linked to resources. The actual type of the resource is indicated by the resource.type property.

The other properties shown for a given resource depend on the type.

Refer to the event listings later in this section for different services, indicating the resource types and the properties which are available.

Event filtering#

In an event type trigger, filtering on the properties of an incoming event is supported.

An event filter is of the form:

{  "filter": {    <property...>: <wildcard>  }}

For example, to match create events from the Item Service, the event filter would look like the code listing below.

{  "filter": {    "event": "resource.ResourceCreated",    "resource.type": "itemsvc.*"  }}

List of events#

These sections list the following types of events:

Common events
Passport Service events
Workflow Service events

List of resource types#

These sections list the following resource types:

Passport Service resource types
File Service resource types
Item Service resource types
Object Model Service resource types
Datasources Service resource types

Common events#

resource.ResourceCreated#

A resource created event is emitted when a resource is created.

Property	Type
`uuid`	UUID
`resource`
`user`
`_id`	string
`timestamp`	timestamp
`requestId`	string

Example event#

{    "event": "resource.ResourceCreated",    "uuid": "8f2792c7-b01a-4493-ba5a-d0588a4aad8e",    "resource": {        "type": "custom.Resource",        ...    }    "user": {        "id": "00b82755-b5e6-4c8b-a4cf-66bb4f697f17"    },    "requestId": "abe50236-cf30-435f-b7fc-c05cb8f0f320"
 }

resource.ResourceUpdated#

A resource updated event is emitted when a resource is changed.

Property	Type
`uuid`	UUID
`resource`
`user`
`_id`	string
`timestamp`	timestamp
`requestId`	string

Example event#

{    "event": "resource.ResourceUpdated",    "uuid": "8f2792c7-b01a-4493-ba5a-d0588a4aad8e",    "resource": {        "type": "custom.Resource",        ...    }    "user": {        "id": "00b82755-b5e6-4c8b-a4cf-66bb4f697f17"    },    "requestId": "abe50236-cf30-435f-b7fc-c05cb8f0f320"
 }

resource.ResourceSoftDeleted#

A resource soft deleted event is emitted if a resource is marked for deletion but not yet permanently deleted.

Typically, a resource.ResourceHardDeleted event will follow a resource.ResourceSoftDeleted event. However, not all services support soft delete and in this case, only a resource.ResourceHardDeleted is emitted.

Property	Type
`uuid`	UUID
`resource`
`user`
`_id`	string
`timestamp`	timestamp
`requestId`	string

Example event#

{    "event": "resource.ResourceSoftDeleted",    "uuid": "8f2792c7-b01a-4493-ba5a-d0588a4aad8e",    "resource": {        "type": "custom.Resource",        ...    }    "user": {        "id": "00b82755-b5e6-4c8b-a4cf-66bb4f697f17"    },    "requestId": "abe50236-cf30-435f-b7fc-c05cb8f0f320"
 }

resource.ResourceHardDeleted#

A resource hard deleted event is emitted if a resource is deleted permanently. This means is it either deleted with ?purge=true or otherwise deleted in a way that means it cannot be recovered.

Property	Type
`uuid`	UUID
`resource`
`user`
`_id`	string
`timestamp`	timestamp
`requestId`	string

Example event#

{    "event": "resource.ResourceHardDeleted",    "uuid": "8f2792c7-b01a-4493-ba5a-d0588a4aad8e",    "resource": {        "type": "custom.Resource",        ...    }    "user": {        "id": "00b82755-b5e6-4c8b-a4cf-66bb4f697f17"    },    "requestId": "abe50236-cf30-435f-b7fc-c05cb8f0f320"
 }

Passport Service events#

passportsvc.Login#

A login event is emitted when a user logs into the Passport Service. This type of event is only emitted when a login is initiated through a user interface, for example, through a web page. It does not occur for requests that are only authenticated as a particular user.

Property	Type
`uuid`	string
`user`
`_id`	string
`timestamp`	timestamp
`requestId`	string

Example event#

{    "event": "passportsvc.Login",    "uuid": "8f2792c7-b01a-4493-ba5a-d0588a4aad8e",    "user": {        "id": "00b82755-b5e6-4c8b-a4cf-66bb4f697f17"    },    "requestId": "abe50236-cf30-435f-b7fc-c05cb8f0f320"
 }

passportsvc.Logout#

A logout event is emitted when a user logs outs of the Passport Service, for example, by clicking logout in the console.

Property	Type
`uuid`	string
`user`
`_id`	string
`timestamp`	timestamp
`requestId`	string

Example event#

{    "event": "passportsvc.Logout",    "uuid": "8f2792c7-b01a-4493-ba5a-d0588a4aad8e",    "user": {        "id": "00b82755-b5e6-4c8b-a4cf-66bb4f697f17"    },    "requestId": "abe50236-cf30-435f-b7fc-c05cb8f0f320"
 }

Workflow Service events#

workflowsvc.UserInput#

A user input event is emitted from a workflow at the point where a workflow requires user input.

This could be used to send a notification to the user that indicates they need to provide input in order to continue the workflow.

Property	Type
`uuid`	string
`namespaces`	string[]
`notificationId`	string
`url`	string
`inputParams`	map
`requestId`	string
`timestamp`	timestamp

Example event#

{    "event": "workflowsvc.UserInput",    "uuid": "8f2792c7-b01a-4493-ba5a-d0588a4aad8e",    "notificationId": "00b82755-b5e6-4c8b-a4cf-66bb4f697f17",    "url": "http://example.com",    "inputParams": {        "some": "value",        "other": 1    },    "requestId": "abe50236-cf30-435f-b7fc-c05cb8f0f320" }

Resource types#

Passport Service resource types#

passportsvc.Application#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
	`organizationId`	string
	`organizationNamespaces`	string[]
	`configs`	map
`before`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`namespaces`	string[]
	`configs`	map
	`appOwner`	string
`after`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`namespaces`	string[]
	`configs`	map
	`appOwner`	string

passportsvc.Namespace#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
`before`
	`namespaces`	string[]
`after`
	`namespaces`	string[]

passportsvc.Organization#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
`before`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`namespaces`	string[]
	`orgOwner`	string
`after`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`namespaces`	string[]
	`orgOwner`	string

passportsvc.Workspace#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
	`appId`	string
	`applicationNamespaces`	string[]
`before`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`namespaces`	string[]
	`appId`	string
`after`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`namespaces`	string[]
	`appId`	string

passportsvc.UserGroup#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
	`appId`	string
	`orgId`	string
	`applicationNamespaces`	string[]
`before`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`namespaces`	string[]
	`appId`	string
	`orgId`	string
`after`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`namespaces`	string[]
	`appId`	string
	`orgId`	string

passportsvc.User#

Object	Property	Type
`resource`
	`id`	string
`before`
	`firstName`	string
	`lastName`	string
	`email`	string
	`eusa`	boolean
	`privacy`	boolean
	`disabled`	boolean
	`notificationConfigured`	boolean
`after`
	`firstName`	string
	`lastName`	string
	`email`	string
	`eusa`	boolean
	`privacy`	boolean
	`disabled`	boolean
	`notificationConfigured`	boolean

passportsvc.ApiKey#

Object	Property	Type
`resource`
	`id`	string
	`user`	string
	`namespace`	string
`before`
	`name`	string
	`expiryDateTime`	timestamp
	`revoked`	boolean
	`revokedBy`	string
	`revokedDateTime`	timestamp
`after`
	`name`	string
	`expiryDateTime`	timestamp
	`revoked`	boolean
	`revokedBy`	string
	`revokedDateTime`	timestamp

File Service resource types#

filesvc.File#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
	`fileType`	string
`before`
	`name`	string
	`parents`	string[]
	`namespaces`	string[]
	`fileType`	string
	`status`	string
	`tags`	string[]
	`tipVersion`	integer
`after`
	`name`	string
	`parents`	string[]
	`namespaces`	string[]
	`fileType`	string
	`status`	string
	`tags`	string[]
	`tipVersion`	integer

filesvc.FileVersion#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
	`fileType`	string
	`field`	string
	`version`	integer
`before`
	`name`	string
	`field`	string
	`version`	integer
	`parents`	string[]
	`namespaces`	string[]
	`fileType`	string
	`status`	string
	`tags`	string[]
	`size`	integer
`after`
	`name`	string
	`field`	string
	`version`	integer
	`parents`	string[]
	`namespaces`	string[]
	`fileType`	string
	`status`	string
	`tags`	string[]
	`size`	integer

Item Service resource types#

itemsvc.NamedCompositeItem#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
	`userItemid`	string
`before`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`itemClass`	string
	`kind`	string
	`namespaces`	string[]
	`tipVersion`	integer
`after`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`itemClass`	string
	`kind`	string
	`namespaces`	string[]
	`tipVersion`	integer

itemsvc.NamedCompositeItemVersion#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
	`userItemDbld`	string
	`userItemId`	string
	`version`	integer
`before`
	`namespaces`	string[]
	`userItemDbld`	string
	`userItemId`	string
	`userType`	string
	`shortName`	string
	`itemClass`	string
	`kind`	string
	`namespaces`	string[]
	`tipVersion`	integer
`after`
	`namespaces`	string[]
	`userItemDbld`	string
	`userItemId`	string
	`userType`	string
	`shortName`	string
	`itemClass`	string
	`kind`	string
	`namespaces`	string[]
	`tipVersion`	integer

itemsvc.NamedTelemetryCollectionVersion#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
	`userItemDbld`	string
	`userItemId`	string
	`version`	integer
`before`
	`namespaces`	string[]
	`userItemDbld`	string
	`userItemId`	string
	`itemClass`	string
	`version`	integer
`after`
	`namespaces`	string[]
	`userItemDbld`	string
	`userItemId`	string
	`itemClass`	string
	`version`	integer

itemsvc.NamedUserCollection#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
	`userItemId`	string
`before`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`itemClass`	string
	`kind`	string
	`namespaces`	string[]
	`tipversion`	integer
`after`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`itemClass`	string
	`kind`	string
	`namespaces`	string[]
	`tipversion`	integer

itemsvc.NamedUserCollectionVersion#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
	`userItemDbId`	string
	`userItemId`	string
	`version`	integer
`before`
	`namespaces`	string[]
	`userItemDbld`	string
	`userItemId`	string
	`itemClass`	string
	`version`	integer
`after`
	`namespaces`	string[]
	`userItemDbld`	string
	`userItemId`	string
	`itemClass`	string
	`version`	integer

itemsvc.SchemaDefinition#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
`before`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`definition`	string
	`namespaces`	string[]
`after`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`definition`	string
	`namespaces`	string[]

itemsvc.Script#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
	`userItemId`	string
`before`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`itemClass`	string
	`kind`	string
	`namespaces`	string[]
	`tipVersion`	integer
`after`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`itemClass`	string
	`kind`	string
	`namespaces`	string[]
	`tipVersion`	integer

itemsvc.ScriptVersion#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
	`userItemDbId`	string
	`userItemId`	string
	`version`	integer
`before`
	`namespaces`	string[]
	`userItemDbId`	string
	`userItemId`	string
	`itemClass`	string
	`version`	integer
`after`
	`namespaces`	string[]
	`userItemDbId`	string
	`userItemId`	string
	`itemClass`	string
	`version`	integer

itemsvc.UserConfig#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
	`userItemId`	string
`before`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`itemClass`	string
	`kind`	string
	`namespaces`	string[]
	`tipVersion`	integer
`after`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`itemClass`	string
	`kind`	string
	`namespaces`	string[]
	`tipVersion`	integer

itemsvc.UserConfigVersion#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
	`userItemDbId`	string
	`userItemId`	string
	`version`	integer
`before`
	`namespaces`	string[]
	`userItemDbId`	string
	`userItemId`	string
	`itemClass`	string
	`version`	integer
`after`
	`namespaces`	string[]
	`userItemDbId`	string
	`userItemId`	string
	`itemClass`	string
	`version`	integer

Object Model Service resource types#

omapisvc.APIConfig#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
`before`
	`name`	string
	`description`	string
`after`
	`name`	string
	`description`	string

Example:

{  "event": "resource.ResourceUpdated",  "resource": {     "type": "omapisvc.APIConfig",     "namespaces": ["X"],     "before": {         "name": "old name",         ...     },     "after": {        "name": "new name",        ...            },     ...  },  ... }

Datasources Service resource types#

datasources.Orchestrator#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
`before`
	`name`	string
	`userType`	string
	`orchestratorClass`	string
`after`
	`name`	string
	`userType`	string
	`orchestratorClass`	string

Example:

{  "event": "resource.ResourceUpdated",  "resource": {     "type": "datasources.Orchestrator",     "namespaces": ["X"],     "before": {         "name": "X",         ...     },     "after": {        "name": "Y",        ...            },     ...  },  ... }

datasources.OrchestratorRun#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
	`orchestratorId`	string
`before`
	`namespaces`	string[]
	`orchestratorId`	string
	`status`	string
`after`
	`namespaces`	string[]
	`orchestratorId`	string
	`status`	string

Example:

{  "event": "resource.ResourceUpdated",  "resource": {     "type": "datasources.OrchestratorRun",     "namespaces": ["X"],     "orchestratorId": "68a15d18-620c-4672-9e39-34106ed50b08"     "before": {         "status": "RUNNING",         ...     },     "after": {         "status": "COMPLETED",        ...            },     ...  },  ... }

datasources.OrchestratorSchedule#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
	`orchestratorId`	string
`before`
	`namespaces`	string[]
	`orchestratorId`	string
	`runinterval`	string
`after`
	`namespaces`	string[]
	`orchestratorId`	string
	`runinterval`	string

Example:

{  "event": "resource.ResourceUpdated",  "resource": {     "type": "datasources.OrchestratorSchedule",     "namespaces": ["X"],     "orchestratorId": "68a15d18-620c-4672-9e39-34106ed50b08",     "before": {         "runinterval": "* * * 0",         ...     },     "after": {         "runinterval": "* * * 1",        ...            },     ...  },  ... }

AI Service resource types#

aisvc.Agent#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
`before`
	`namespaces`	string[]
	`name`	string
	`description`	string
	`background`	string
	`user_type`	string
	`type`	string
	`config`	object
	`tools`	string[]
	`knowledgebases`	string[]
	`agent_class`	string
`after`
	`namespaces`	string[]
	`name`	string
	`description`	string
	`background`	string
	`user_type`	string
	`type`	string
	`config`	object
	`tools`	string[]
	`knowledgebases`	string[]
	`agent_class`	string

aisvc.Team#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
`before`
	`namespaces`	string[]
	`name`	string
	`agents`	array
	`flow`	array
	`permissionProfileId`	string
`after`
	`namespaces`	string[]
	`name`	string
	`agents`	array
	`flow`	array
	`permissionProfileId`	string

aisvc.Tool#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
`before`
	`namespaces`	string[]
	`name`	string
	`description`	string
	`user_type`	string
	`tool_class`	string
	`type`	string
`after`
	`namespaces`	string[]
	`name`	string
	`description`	string
	`user_type`	string
	`tool_class`	string
	`type`	string

aisvc.KnowledgeBase#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
`before`
	`namespaces`	string[]
	`user_type`	string
	`name`	string
	`vectorized_status`	string
	`file_id`	string
	`file_version_id`	string
`after`
	`namespaces`	string[]
	`user_type`	string
	`name`	string
	`vectorized_status`	string
	`file_id`	string
	`file_version_id`	string

aisvc.McpTool#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
`before`
	`namespaces`	string[]
	`name`	string
	`description`	string
	`script`	object
	`schema`	object
`after`
	`namespaces`	string[]
	`name`	string
	`description`	string
	`script`	object
	`schema`	object

aisvc.McpToolFilter#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
`before`
	`namespaces`	string[]
	`name`	string
	`description`	string
	`user_type`	string
	`criteria`	object
`after`
	`namespaces`	string[]
	`name`	string
	`description`	string
	`user_type`	string
	`criteria`	object

aisvc.ExternalMcpServerConfig#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
`before`
	`namespaces`	string[]
	`name`	string
	`description`	string
	`user_type`	string
	`transport`	string
	`connection`	object
`after`
	`namespaces`	string[]
	`name`	string
	`description`	string
	`user_type`	string
	`transport`	string
	`connection`	object

Workflow Service resource types#

workflowsvc.Workflow#

Object	Property	Type
`resource`
	`id`	string
`before`
	`_id`	UUID
	`_workflowDefId`	UUID
	`_name`	string
	`_description`	string
	`_namespaces`	string[]
	`_userType`	string
	`_status`	string
	`_duration`	number
`after`
	`_id`	UUID
	`_workflowDefId`	UUID
	`_name`	string
	`_description`	string
	`_namespaces`	string[]
	`_userType`	string
	`_status`	string
	`_duration`	number

workflowsvc.WorkflowDef#

Object	Property	Type
`resource`
	`id`	string
`before`
	`_id`	UUID
	`_name`	string
	`_description`	string
	`_namespaces`	string[]
	`_userType`	string
`after`
	`_id`	UUID
	`_name`	string
	`_description`	string
	`_namespaces`	string[]
	`_userType`	string

workflowsvc.WorkflowCompleted#

Object	Property	Type
`resource`
`id`	string
`after` (typical)
	`_id`	UUID
	`_workflowDefId`	UUID
	`_name`	string
	`_description`	string
	`_namespaces`	string[]
	`_userType`	string
	`_status`	string
	`_duration`	number

workflowsvc.Task#

Object	Property	Type
`resource`
	`id`	string
`after` (typical)
	`_id`	UUID
	`_workflowId`	UUID
	`_name`	string
	`_description`	string
	`_namespaces`	string[]
	`_taskType`	string
	`_status`	string
	`_duration`	number

workflowsvc.WorkflowSchedule#

Object	Property	Type
`resource`
	`id`	string (job key)
`before`
	`_namespaces`	string[]
	`_workflowDefId`	UUID
	`_workflowDefName`	string
	`_jobKey`	string
`after`
	`_namespaces`	string[]
	`_workflowDefId`	UUID
	`_workflowDefName`	string
	`_jobKey`	string