Skip to main content

Events defined in the "builder" namespace

blueprint-completed​

This event is logged when the user create one or more entities with a specific blueprint.

JSON schema of the payload​

Loading ....

Example of payload​

{
  "templateRef": "template:default/dataproduct-template"
}

blueprint-navigated​

This event is logged when the user navigated to a specific blueprint page.

JSON schema of the payload​

Loading ....

Example of payload​

{
  "templateRef": "template:default/dataproduct-template"
}

blueprint-registered​

This event is logged when a new blueprint has been registered in the platform.

JSON schema of the payload​

Loading ....

Example of payload​

{
  "registeredAt": "2025-02-14T09:09:59.714Z",
  "entityRef": "template:default/dataproduct-template"
}

blueprint-unregistered​

This event is logged when a blueprint has been unregistered from the platform.

JSON schema of the payload​

Loading ....

Example of payload​

{
  "entityRef": "blueprint:default/blueprint-name",
  "entity": {
    "kind": "Blueprint",
    "metadata": {
      "name": "blueprint-name"
    }
  },
  "entityUrn": "urn:dmb:blueprint:blueprint-name"
}

component-registered​

This event is logged when a new component has been registered in the platform.

JSON schema of the payload​

Loading ....

Example of payload​

{
  "domain": "domain:domain-name",
  "entityRef": "component:default/domain-name.system-name.0.output-port",
  "registeredAt": "2025-02-14T09:09:59.714Z"
}

component-unregistered​

This event is logged when a component has been unregistered from the platform.

JSON schema of the payload​

Loading ....

Example of payload​

{
  "entity": {
    "kind": "Component",
    "metadata": { "name": "domain-name.system-name.0.output-port" }
  },
  "entityRef": "component:default/domain-name.system-name.0.output-port",
  "entityUrn": "urn:dmb:cmp:domain-name:system-name:0:output-port"
}

creation-template-navigated​

This event is logged when a user navigated to a specific creation template page.

JSON schema of the payload​

Loading ....

Example of payload​

{
  "templateRef": "template:default/dataproduct-template"
}

creation-template-registered​

This event is logged when a new creation template has been registered in the platform.

JSON schema of the payload​

Loading ....

Example of payload​

{
  "entityRef": "template:default/dataproduct-template",
  "registeredAt": "2024-08-22T09:22:08.942Z"
}

domain-registered​

This event is logged when a new domain has been registered in the platform.

JSON schema of the payload​

Loading ....

Example of payload​

{
  "entityRef": "domain:default/domain-name",
  "registeredAt": "2025-03-10T16:07:42.117Z"
}

domain-unregistered​

This event is logged when a domain has been unregistered from the platform.

JSON schema of the payload​

Loading ....

Example of payload​

{
  "entityRef": "domain:default/domain-name",
  "entity": {
    "kind": "Domain",
    "metadata": {
      "name": "domain-name"
    }
  },
  "entityUrn": "urn:dmb:dmn:domain-name"
}

edit-template-completed​

This event is logged when the user updates metadata of a system or component using an edit template.

JSON schema of the payload​

Loading ....

Example of payload​

{
  "entityRef": "component:default/domain-name.system-name.0.output-port",
  "templateRef": "edittemplate:default/output-port-edit-template"
}

edit-template-navigated​

This event is logged when the user navigated to a specific system or component to change using the edit template.

JSON schema of the payload​

Loading ....

Example of payload​

{
  "entityRef": "component:default/domain-name.system-name.0.output-port",
  "templateRef": "edittemplate:default/output-port-edit-template"
}

entity-created​

This event is logged when an entity has been created by scaffolding a template.

JSON schema of the payload​

Loading ....

Example of payload​

{
  "entityRef": "system:default/domain-name.system-name.0",
  "catalogInfoUrl": "https://gitlab.com/name.surname/system-name/-/blob/master/catalog-info.yaml"
}

entity-deploy-requested​

This event is logged when a deploy request for a system or component has been sent.

JSON schema of the payload​

Loading ....

Example of payload​

{
  "urn": "urn:dmb:dp:domain-name:system-name:0",
  "version": "0.1.0-SNAPSHOT-1",
  "entityRef": "system:default/domain-name.system-name.0",
  "environment": "production"
}

entity-new-version-created​

This event is logged when a new version of the entity has been created.

JSON schema of the payload​

Loading ....

Example of payload​

{
  "version": "1",
  "entityRef": "system:default/domain-name.system-name.0"
}

entity-test-requested​

This event is logged when a test request for a system or component has been sent.

JSON schema of the payload​

Loading ....

Example of payload​

{
  "entityRef": "system:default/domain-name.system-name.0"
}

entity-undeploy-requested​

This event is logged when an undeploy request for a system or component has been sent.

JSON schema of the payload​

Loading ....

Example of payload​

{
  "urn": "urn:dmb:dp:domain-name:system-name:0",
  "version": "0.1.0-SNAPSHOT-1",
  "entityRef": "system:default/domain-name.system-name.0",
  "environment": "production"
}

release-created​

This event is logged when a draft or stable release has been created.

JSON schema of the payload​

Loading ....

Example of payload​

{
  "version": "0.1-SNAPSHOT-1",
  "entityRef": "release:default/domain-name.system-name.0.1"
}

reverse-provisioning-template-completed​

This event is logged when the reverse provisioning is performed and completed for a specific entity.

JSON schema of the payload​

Loading ....

Example of payload​

{
  "entityRef": "component:default/domain-name.system-name.0.output-port",
  "templateRef": "reverseprovisioningtemplate:default/reverse-provisioning-output-port"
}

reverse-provisioning-template-navigated​

This event is logged when the user navigated to the reverse provisioning page for a specific entity.

JSON schema of the payload​

Loading ....

Example of payload​

{
  "entityRef": "component:default/domain-name.system-name.0.output-port",
  "templateRef": "reverseprovisioningtemplate:default/reverse-provisioning-output-port"
}

system-registered​

This event is logged when a new system has been registered in the platform.

JSON schema of the payload​

Loading ....

Example of payload​

{
  "domain": "domain:domain-name",
  "entityRef": "system:default/domain-name.system-name.0",
  "registeredAt": "2025-02-13T09:09:59.714Z"
}

system-unregistered​

This event is logged when a system has been unregistered from the platform.

JSON schema of the payload​

Loading ....

Example of payload​

{
  "entityRef": "system:default/system-name",
  "entity": {
    "kind": "System",
    "metadata": {
      "name": "system-name"
    }
  },
  "entityUrn": "urn:dmb:dp:system-name"
}

taxonomy-registered​

This event is logged when a new taxonomy has been registered in the platform.

JSON schema of the payload​

Loading ....

Example of payload​

{
  "entityRef": "taxonomy:default/taxonomy-name",
  "registeredAt": "2025-02-13T09:09:59.714Z"
}

taxonomy-unregistered​

This event is logged when a taxonomy has been unregistered from the platform.

JSON schema of the payload​

Loading ....

Example of payload​

{
  "entityRef": "taxonomy:default/taxonomy-name",
  "entity": {
    "kind": "Taxonomy",
    "metadata": {
      "name": "taxonomy-name"
    }
  },
  "entityUrn": "urn:dmb:taxonomy:taxonomy-name"
}

template-unregistered​

This event is logged when a creation template has been unregistered from the platform.

JSON schema of the payload​

Loading ....

Example of payload​

{
  "entityRef": "template:default/template-name",
  "entity": {
    "kind": "Template",
    "metadata": {
      "name": "template-name"
    }
  },
  "entityUrn": "urn:dmb:template:template-name"
}