Notification Service events # 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.
# 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.
# In an event type trigger, filtering on the properties of a incoming event is supported.
An event filter is of the form:
{ "filter" : { <property...> : <wildcard> } } Copy 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.*" } } Copy # These sections list the following types of events:
# These sections list the following resource types:
# # A resource created event is emitted when a resource is created.
Property Type uuidUUID resourceuser_idstring timestamptimestamp requestIdstring
# { "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"
} Copy # A resource updated event is emitted when a resource is changed.
Property Type uuidUUID resourceuser_idstring timestamptimestamp requestIdstring
# { "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"
} Copy # 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 uuidUUID resourceuser_idstring timestamptimestamp requestIdstring
# { "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"
} Copy # 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 uuidUUID resourceuser_idstring timestamptimestamp requestIdstring
# { "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"
} Copy # # 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 uuidstring user_idstring timestamptimestamp requestIdstring
# { "event" : "passportsvc.Login" , "uuid" : "8f2792c7-b01a-4493-ba5a-d0588a4aad8e" , "user" : { "id" : "00b82755-b5e6-4c8b-a4cf-66bb4f697f17" } , "requestId" : "abe50236-cf30-435f-b7fc-c05cb8f0f320"
} Copy # A logout event is emitted when a user logs outs of the Passport Service, for example, by clicking logout in the console.
Property Type uuidstring user_idstring timestamptimestamp requestIdstring
# { "event" : "passportsvc.Logout" , "uuid" : "8f2792c7-b01a-4493-ba5a-d0588a4aad8e" , "user" : { "id" : "00b82755-b5e6-4c8b-a4cf-66bb4f697f17" } , "requestId" : "abe50236-cf30-435f-b7fc-c05cb8f0f320"
} Copy # # 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 uuidstring namespacesstring[] notificationIdstring urlstring inputParamsmap requestIdstring timestamptimestamp
# { "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" } Copy # # # Property Type idstring namespacesstring[] configsmap before/after namestring namespacesstring[] configsmap descriptionstring userTypestring shortNamestring[] appOwnerstring
# Property Type idstring namespacesstring[] before/after namespacesstring[]
# Property Type idstring namespacesstring[] before/after namestring namespacesstring[] descriptionstring
# # Property Type idstring namespacesstring[] fileTypestring before/after namestring parentsstring[] namespacesstring[] fileTypestring statusstring tagsstring[] tipVersioninteger
# Property Type idstring namespacesstring[] fileTypestring fieldstring versioninteger before/after namestring fieldstring versioninteger parentsstring[] namespacesstring[] fileTypestring statusstring tagsstring[] sizeinteger
# # Property Type idstring namespacesstring[] userItemidstring before/after namestring descriptionstring userTypestring shortNamestring itemClassstring kindstring namespacesstring[] tipVersioninteger
# Property Type idstring namespacesstring[] userItemDbldstring userItemIdstring versioninteger before/after namespacesstring[] userItemDbldstring userItemIdstring userTypestring shortNamestring itemClassstring kindstring namespacesstring[] tipVersioninteger
# Property Type idstring namespacesstring[] userItemDbldstring userItemIdstring versioninteger before/after namespacesstring[] userItemDbldstring userItemIdstring itemClassstring versioninteger
# Property Type idstring namespacesstring[] userItemIdstring before/after namestring descriptionstring userTypestring shortNamestring itemClassstring kindstring namespacesstring[] tipversioninteger
# Property Type idstring namespacesstring[] userItemDbIdstring userItemIdstring versioninteger before/after namespacesstring[] userItemDbldstring userItemIdstring itemClassstring versioninteger
# Property Type idstring namespacesstring[] before/after namestring descriptionstring userTypestring shortNamestring definitionstring namespacesstring[]
# Property Type idstring namespacesstring[] userItemIdstring before/after namestring descriptionstring userTypestring shortNamestring itemClassstring kindstring namespacesstring[] tipVersioninteger
# Property Type idstring namespacesstring[] userItemDbIdstring userItemIdstring versioninteger before/after namespacesstring[] userItemDbIdstring userItemIdstring itemClassstring versioninteger
# Property Type idstring namespacesstring[] userItemIdstring before/after namestring descriptionstring userTypestring shortNamestring itemClassstring kindstring namespacesstring[] tipVersioninteger
# Property Type idstring namespacesstring[] userItemDbIdstring userItemIdstring versioninteger before/after namespacesstring[] userItemDbIdstring userItemIdstring itemClassstring versioninteger
# # Property Type idstring namespacesstring[] before/after namestring descriptionstring
Example:
{ "event" : "resource.ResourceUpdated" , "resource" : { "type" : "omapisvc.APIConfig" , "namespaces" : [ "X" ] , "before" : { "name" : "old name" , ... } , "after" : { "name" : "new name" , ... } , ... } , ... }
Copy # # Property Type idstring namespacesstring[] before/after namestring userTypestring orchestratorClassstring
Example:
{ "event" : "resource.ResourceUpdated" , "resource" : { "type" : "datasources.Orchestrator" , "namespaces" : [ "X" ] , "before" : { "name" : "X" , ... } , "after" : { "name" : "Y" , ... } , ... } , ... }
Copy # Property Type idstring namespacesstring[] orchestratorIdstring before/after namespacesstring[] orchestratorIdstring statusstring
Example:
{ "event" : "resource.ResourceUpdated" , "resource" : { "type" : "datasources.OrchestratorRun" , "namespaces" : [ "X" ] , "orchestratorId" : "68a15d18-620c-4672-9e39-34106ed50b08" "before" : { "status" : "RUNNING" , ... } , "after" : { "status" : "COMPLETED" , ... } , ... } , ... }
Copy # Property Type idstring namespacesstring[] orchestratorIdstring before/after namespacesstring[] orchestratorIdstring runintervalstring
Example:
{ "event" : "resource.ResourceUpdated" , "resource" : { "type" : "datasources.OrchestratorSchedule" , "namespaces" : [ "X" ] , "orchestratorId" : "68a15d18-620c-4672-9e39-34106ed50b08" , "before" : { "runinterval" : "* * * 0" , ... } , "after" : { "runinterval" : "* * * 1" , ... } , ... } , ... }
Copy