Skip to main content
Version: 13.x (Current)

Console Events

Events allow users to be notified when certain operations are performed in the Console.

Event properties

All the events triggered by the Console share some common properties:

PropertyValueDescription
eventNamestringThe name of the event, usually in the form of subject_action
eventTimestampnumberThe timestamp of the event emission
payloadobjectContains the event-specific payload

Event types

Below are explained the events that can be triggered by the Console.

Project Created

This event will be triggered when a Project is created successfully.

PropertyValueDescription
tenantIdstringThe identifier of the Company the Project belongs to
projectIdstringThe identifier of the newly created Project
sourceTemplateIdstringThe identifier of the project template used to create the Project
projectobjectThe Project metadata (ideally, the whole Project resource, plus some additional information related to the creation process)

Service Created

This event will be triggered when a microservice is successfully generated from a marketplace template or example.

note

The event is triggered as soon as the service's repository is successfully created, hence there is no guarantee that the service will be found in the Project configuration, yet.

PropertyValueDescription
tenantIdstringThe identifier of the Company the service belongs to
projectIdstringThe identifier of the Project the service belongs to
repositoryURLstringThe URL of the repository that hosts the service code
serviceNamestringThe name of the service inside the Project configuration
templateIdstringThe identifier of the template in the Console marketplace from which the service was created

Tag or Version Created

This event will be triggered when a Project is successfully tagged from Console. In an Enhanced Workflow project, this event will be triggered when a version is created.

PropertyValueDescription
tenantIdstringThe identifier of the Company the service belongs to
projectIdstringThe identifier of the Project the service belongs to
tagNamestringThe name of the tag created from the Console
refstringThe ref of the tag
messagestringThe message of the tag compiled from the Console
releaseDescriptionstringThe release description of the tag compiled from the Console
projectobjectThe Project metadata (ideally, the whole Project resource)

User added

Available from v12.3.0

This event will be triggered when a user gains access to a company, project, or environment, either directly or via a group.

note

This event does not guarantee that the user in question already had access to the resource via another group, or directly.

PropertyValueDescription
userIdstringThe user identifier
emailstringThe user email
roleIdstringThe identifier of the role assigned to the user
groupIdstringThe identifier of the group through which the user was added to the Company (if any)
resourceobjectThe field identifies the resource affected by the operation. By inheritance, all lower level resources could also be affected

User edited

Available from v12.3.0

This event will be triggered when a user changes access to a company, project, or environment, either directly or via a group.

note

This event does not guarantee that the user in question already has an higher-privileged access to the resource via another group, or directly.

PropertyValueDescription
userIdstringThe user identifier
emailstringThe user email
roleIdstringThe identifier of the role assigned to the user
groupIdstringThe identifier of the group through which the user was added to the Company (if any)
resourceobjectThe field identifies the resource affected by the operation. By inheritance, all lower level resources could also be affected

User removed

Available from v12.3.0

This event will be triggered when a user loses access to a company, project, or environment, either directly or via a group.

note

This event does not guarantee that the user in question already had access to the resource via another group, or directly.

PropertyValueDescription
userIdstringThe user identifier
emailstringThe user email
roleIdstringThe identifier of the role assigned to the user
groupIdstringThe identifier of the group through which the user was added to the Company (if any)
resourceobjectThe field identifies the resource affected by the operation. By inheritance, all lower level resources could also be affected