Message bus events

This document provides detailed documentation for all events used in the Infrahub message bus system.

info

For more detailed explanations on how to use these events within Infrahub, see the event handling topic.

Messages events

Check Artifact

Event check.artifact.create

Description: Runs a check to verify the creation of an artifact.

Priority: 2

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
artifact_name	Name of the artifact	string	None
artifact_definition	The the ID of the artifact definition	string	None
commit	The commit to target	string	None
content_type	Content type of the artifact	string	None
transform_type	The type of transform associated with this artifact	string	None
transform_location	The transforms location within the repository	string	None
repository_id	The unique ID of the Repository	string	None
repository_name	The name of the Repository	string	None
repository_kind	The kind of the Repository	string	None
branch_name	The branch where the check is run	string	None
target_id	The ID of the target object for this artifact	string	None
target_name	Name of the artifact target	string	None
artifact_id	The id of the artifact if it previously existed	N/A	None
query	The name of the query to use when collecting data	string	None
timeout	Timeout for requests used to generate this artifact	integer	None
variables	Input variables when generating the artifact	object	None
validator_id	The ID of the validator	string	None

Check Generator

Event check.generator.run

Description: A check that runs a generator.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
generator_definition	The Generator definition	N/A	None
generator_instance	The id of the generator instance if it previously existed	N/A	None
commit	The commit to target	string	None
repository_id	The unique ID of the Repository	string	None
repository_name	The name of the Repository	string	None
repository_kind	The kind of the Repository	string	None
branch_name	The branch where the check is run	string	None
target_id	The ID of the target object for this generator	string	None
target_name	Name of the generator target	string	None
query	The name of the query to use when collecting data	string	None
variables	Input variables when running the generator	object	None
validator_id	The ID of the validator	string	None

Check Repository

Event check.repository.check_definition

Description: Triggers user defined checks to run based on a Check Definition.

Priority: 2

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
check_definition_id	The unique ID of the check definition	string	None
commit	The commit to target	string	None
repository_id	The unique ID of the Repository	string	None
repository_name	The name of the Repository	string	None
branch_name	The branch where the check is run	string	None
file_path	The path and filename of the check	string	None
class_name	The name of the class containing the check	string	None
proposed_change	The unique ID of the Proposed Change	string	None
branch_diff	The calculated diff between the two branches	N/A	None

Event check.repository.merge_conflicts

Description: Runs a check to validate if there are merge conflicts for a proposed change between two branches.

Priority: 2

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
validator_id	The id of the validator associated with this check	string	None
validator_execution_id	The id of current execution of the associated validator	string	None
check_execution_id	The unique ID for the current execution of this check	string	None
proposed_change	The unique ID of the Proposed Change	string	None
repository_id	The unique ID of the Repository	string	None
repository_name	The name of the Repository	string	None
source_branch	The source branch	string	None
target_branch	The target branch	string	None

Event check.repository.user_check

Description: Runs a check as defined within a CoreCheckDefinition within a repository.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
validator_id	The id of the validator associated with this check	string	None
validator_execution_id	The id of current execution of the associated validator	string	None
check_execution_id	The unique ID for the current execution of this check	string	None
check_definition_id	The unique ID of the check definition	string	None
commit	The commit to target	string	None
repository_id	The unique ID of the Repository	string	None
repository_name	The name of the Repository	string	None
branch_name	The branch where the check is run	string	None
file_path	The path and filename of the check	string	None
class_name	The name of the class containing the check	string	None
proposed_change	The unique ID of the Proposed Change	string	None
variables	Input variables when running the check	object	None
name	The name of the check	string	None
branch_diff	The calculated diff between the two branches	N/A	None

Event Branch

Event event.branch.create

Description: Sent a new branch is created.

Priority: 5

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
branch	The branch that was created	string	None
branch_id	The unique ID of the branch	string	None
sync_with_git	Indicates if Infrahub should extend this branch to git.	boolean	None

Event event.branch.delete

Description: Sent when a branch has been deleted.

Priority: 5

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
branch	The branch that was deleted	string	None
branch_id	The unique ID of the branch	string	None
sync_with_git	Indicates if the branch was extended to Git	boolean	None

Event event.branch.merge

Description: Sent when a branch has been merged.

Priority: 5

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
source_branch	The source branch	string	None
target_branch	The target branch	string	None

Event event.branch.rebased

Description: Sent when a branch has been rebased.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
branch	The branch that was rebased	string	None

Event Node

Event event.node.mutated

Description: Sent when a node has been mutated

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
branch	The branch that was created	string	None
kind	The type of object modified	string	None
node_id	The ID of the mutated node	string	None
action	The action taken on the node	string	None
data	Data on modified object	object	None

Event Schema

Event event.schema.update

Description: Sent when the schema on a branch has been updated.

Priority: 5

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
branch	The branch where the update occurred	string	None

Event Worker

Event event.worker.new_primary_api

Description: Sent on startup or when a new primary API worker is elected.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
worker_id	The worker ID that got elected	string	None

Finalize Validator

Event finalize.validator.execution

Description: Update the status of a validator after all checks have been completed.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
validator_id	The id of the validator associated with this check	string	None
validator_execution_id	The id of current execution of the associated validator	string	None
start_time	Start time when the message was first created	string	None
validator_type	The type of validator to complete	string	None

Git File

Event git.file.get

Description: Read a file from a Git repository.

Priority: 4

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
commit	The commit id to use to access the file	string	None
file	The path and filename within the repository	string	None
repository_id	The unique ID of the Repository	string	None
repository_name	The name of the repository	string	None
repository_kind	The kind of the repository	string	None

Git Repository

Event git.repository.connectivity

Description: Validate connectivity and credentials to remote repository

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
repository_name	The name of the repository	string	None
repository_location	The location of repository	string	None

Schema Migration

Event schema.migration.path

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
branch	The name of the branch to target	N/A	None
migration_name	The name of the migration to run	string	None
new_node_schema	new Schema of Node or Generic to process	N/A	None
previous_node_schema	Previous Schema of Node or Generic to process	N/A	None
schema_path	SchemaPath to the element of the schema to migrate	N/A	None

Schema Validator

Event schema.validator.path

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
branch	The name of the branch to target	N/A	None
constraint_name	The name of the constraint to validate	string	None
node_schema	Schema of Node or Generic to validate	N/A	None
schema_path	SchemaPath to the element of the schema to validate	N/A	None

Refresh Git

Event refresh.git.fetch

Description: Fetch a repository remote changes.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
location	The external URL of the repository	string	None
repository_id	The unique ID of the repository	string	None
repository_name	The name of the repository	string	None
repository_kind	The type of repository	string	None
infrahub_branch_name	Infrahub branch on which to sync the remote repository	string	None

Refresh Registry

Event refresh.registry.branches

Description: Sent to indicate that the registry should be refreshed and new branch data loaded.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None

Event refresh.registry.rebased_branch

Description: Sent to refresh a rebased branch within the local registry.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
branch	The branch that was rebased	string	None

Refresh Webhook

Event refresh.webhook.configuration

Description: Sent to indicate that configuration in the cache for webhooks should be refreshed.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None

Request Artifact Definition

Event request.artifact_definition.check

Description: Sent to validate the generation of artifacts in relation to a proposed change.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
artifact_definition	The Artifact Definition	N/A	None
branch_diff	The calculated diff between the two branches	N/A	None
proposed_change	The unique ID of the Proposed Change	string	None
source_branch	The source branch	string	None
source_branch_sync_with_git	Indicates if the source branch should sync with git	boolean	None
destination_branch	The target branch	string	None

Request Generator Definition

Event request.generator_definition.check

Description: Sent to trigger Generators to run for a proposed change.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
generator_definition	The Generator Definition	N/A	None
branch_diff	The calculated diff between the two branches	N/A	None
proposed_change	The unique ID of the Proposed Change	string	None
source_branch	The source branch	string	None
source_branch_sync_with_git	Indicates if the source branch should sync with git	boolean	None
destination_branch	The target branch	string	None

Request Proposed Change

Event request.proposed_change.pipeline

Description: Sent request the start of a pipeline connected to a proposed change.

Priority: 5

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
proposed_change	The unique ID of the proposed change	string	None
source_branch	The source branch of the proposed change	string	None
source_branch_sync_with_git	Indicates if the source branch should sync with git	boolean	None
destination_branch	The destination branch of the proposed change	string	None
check_type	Can be used to restrict the pipeline to a specific type of job	N/A	all

Event request.proposed_change.refresh_artifacts

Description: Sent trigger the refresh of artifacts that are impacted by the proposed change.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
proposed_change	The unique ID of the Proposed Change	string	None
source_branch	The source branch of the proposed change	string	None
source_branch_sync_with_git	Indicates if the source branch should sync with git	boolean	None
destination_branch	The destination branch of the proposed change	string	None
branch_diff	The calculated diff between the two branches	N/A	None

Request Repository

Event request.repository.checks

Description: Sent to trigger the checks for a repository to be executed.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
proposed_change	The unique ID of the Proposed Change	string	None
repository	The unique ID of the Repository	string	None
source_branch	The source branch	string	None
target_branch	The target branch	string	None

Event request.repository.user_checks

Description: Sent to trigger the user defined checks on a repository.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
proposed_change	The unique ID of the Proposed Change	string	None
repository	The unique ID of the Repository	string	None
source_branch	The source branch	string	None
source_branch_sync_with_git	Indicates if the source branch should sync with git	boolean	None
target_branch	The target branch	string	None
branch_diff	The calculated diff between the two branches	N/A	None

Send Echo

Event send.echo.request

Description: Sent a echo request, i.e., ping message.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
message	The message to send	string	None

Trigger Webhook

Event trigger.webhook.actions

Description: Triggers webhooks to be sent for the given action

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
event_type	The event type	string	None
event_data	The webhook payload	object	None

Responses events

Check Artifact

Event check.artifact.create

Description: Runs a check to verify the creation of an artifact.

Priority: 2

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
artifact_name	Name of the artifact	string	None
artifact_definition	The the ID of the artifact definition	string	None
commit	The commit to target	string	None
content_type	Content type of the artifact	string	None
transform_type	The type of transform associated with this artifact	string	None
transform_location	The transforms location within the repository	string	None
repository_id	The unique ID of the Repository	string	None
repository_name	The name of the Repository	string	None
repository_kind	The kind of the Repository	string	None
branch_name	The branch where the check is run	string	None
target_id	The ID of the target object for this artifact	string	None
target_name	Name of the artifact target	string	None
artifact_id	The id of the artifact if it previously existed	N/A	None
query	The name of the query to use when collecting data	string	None
timeout	Timeout for requests used to generate this artifact	integer	None
variables	Input variables when generating the artifact	object	None
validator_id	The ID of the validator	string	None

Check Generator

Event check.generator.run

Description: A check that runs a generator.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
generator_definition	The Generator definition	N/A	None
generator_instance	The id of the generator instance if it previously existed	N/A	None
commit	The commit to target	string	None
repository_id	The unique ID of the Repository	string	None
repository_name	The name of the Repository	string	None
repository_kind	The kind of the Repository	string	None
branch_name	The branch where the check is run	string	None
target_id	The ID of the target object for this generator	string	None
target_name	Name of the generator target	string	None
query	The name of the query to use when collecting data	string	None
variables	Input variables when running the generator	object	None
validator_id	The ID of the validator	string	None

Check Repository

Event check.repository.check_definition

Description: Triggers user defined checks to run based on a Check Definition.

Priority: 2

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
check_definition_id	The unique ID of the check definition	string	None
commit	The commit to target	string	None
repository_id	The unique ID of the Repository	string	None
repository_name	The name of the Repository	string	None
branch_name	The branch where the check is run	string	None
file_path	The path and filename of the check	string	None
class_name	The name of the class containing the check	string	None
proposed_change	The unique ID of the Proposed Change	string	None
branch_diff	The calculated diff between the two branches	N/A	None

Event check.repository.merge_conflicts

Description: Runs a check to validate if there are merge conflicts for a proposed change between two branches.

Priority: 2

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
validator_id	The id of the validator associated with this check	string	None
validator_execution_id	The id of current execution of the associated validator	string	None
check_execution_id	The unique ID for the current execution of this check	string	None
proposed_change	The unique ID of the Proposed Change	string	None
repository_id	The unique ID of the Repository	string	None
repository_name	The name of the Repository	string	None
source_branch	The source branch	string	None
target_branch	The target branch	string	None

Event check.repository.user_check

Description: Runs a check as defined within a CoreCheckDefinition within a repository.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
validator_id	The id of the validator associated with this check	string	None
validator_execution_id	The id of current execution of the associated validator	string	None
check_execution_id	The unique ID for the current execution of this check	string	None
check_definition_id	The unique ID of the check definition	string	None
commit	The commit to target	string	None
repository_id	The unique ID of the Repository	string	None
repository_name	The name of the Repository	string	None
branch_name	The branch where the check is run	string	None
file_path	The path and filename of the check	string	None
class_name	The name of the class containing the check	string	None
proposed_change	The unique ID of the Proposed Change	string	None
variables	Input variables when running the check	object	None
name	The name of the check	string	None
branch_diff	The calculated diff between the two branches	N/A	None

Event Branch

Event event.branch.create

Description: Sent a new branch is created.

Priority: 5

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
branch	The branch that was created	string	None
branch_id	The unique ID of the branch	string	None
sync_with_git	Indicates if Infrahub should extend this branch to git.	boolean	None

Event event.branch.delete

Description: Sent when a branch has been deleted.

Priority: 5

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
branch	The branch that was deleted	string	None
branch_id	The unique ID of the branch	string	None
sync_with_git	Indicates if the branch was extended to Git	boolean	None

Event event.branch.merge

Description: Sent when a branch has been merged.

Priority: 5

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
source_branch	The source branch	string	None
target_branch	The target branch	string	None

Event event.branch.rebased

Description: Sent when a branch has been rebased.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
branch	The branch that was rebased	string	None

Event Node

Event event.node.mutated

Description: Sent when a node has been mutated

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
branch	The branch that was created	string	None
kind	The type of object modified	string	None
node_id	The ID of the mutated node	string	None
action	The action taken on the node	string	None
data	Data on modified object	object	None

Event Schema

Event event.schema.update

Description: Sent when the schema on a branch has been updated.

Priority: 5

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
branch	The branch where the update occurred	string	None

Event Worker

Event event.worker.new_primary_api

Description: Sent on startup or when a new primary API worker is elected.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
worker_id	The worker ID that got elected	string	None

Finalize Validator

Event finalize.validator.execution

Description: Update the status of a validator after all checks have been completed.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
validator_id	The id of the validator associated with this check	string	None
validator_execution_id	The id of current execution of the associated validator	string	None
start_time	Start time when the message was first created	string	None
validator_type	The type of validator to complete	string	None

Git File

Event git.file.get

Description: Read a file from a Git repository.

Priority: 4

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
commit	The commit id to use to access the file	string	None
file	The path and filename within the repository	string	None
repository_id	The unique ID of the Repository	string	None
repository_name	The name of the repository	string	None
repository_kind	The kind of the repository	string	None

Git Repository

Event git.repository.connectivity

Description: Validate connectivity and credentials to remote repository

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
repository_name	The name of the repository	string	None
repository_location	The location of repository	string	None

Schema Migration

Event schema.migration.path

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
branch	The name of the branch to target	N/A	None
migration_name	The name of the migration to run	string	None
new_node_schema	new Schema of Node or Generic to process	N/A	None
previous_node_schema	Previous Schema of Node or Generic to process	N/A	None
schema_path	SchemaPath to the element of the schema to migrate	N/A	None

Schema Validator

Event schema.validator.path

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
branch	The name of the branch to target	N/A	None
constraint_name	The name of the constraint to validate	string	None
node_schema	Schema of Node or Generic to validate	N/A	None
schema_path	SchemaPath to the element of the schema to validate	N/A	None

Refresh Git

Event refresh.git.fetch

Description: Fetch a repository remote changes.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
location	The external URL of the repository	string	None
repository_id	The unique ID of the repository	string	None
repository_name	The name of the repository	string	None
repository_kind	The type of repository	string	None
infrahub_branch_name	Infrahub branch on which to sync the remote repository	string	None

Refresh Registry

Event refresh.registry.branches

Description: Sent to indicate that the registry should be refreshed and new branch data loaded.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None

Event refresh.registry.rebased_branch

Description: Sent to refresh a rebased branch within the local registry.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
branch	The branch that was rebased	string	None

Refresh Webhook

Event refresh.webhook.configuration

Description: Sent to indicate that configuration in the cache for webhooks should be refreshed.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None

Request Artifact Definition

Event request.artifact_definition.check

Description: Sent to validate the generation of artifacts in relation to a proposed change.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
artifact_definition	The Artifact Definition	N/A	None
branch_diff	The calculated diff between the two branches	N/A	None
proposed_change	The unique ID of the Proposed Change	string	None
source_branch	The source branch	string	None
source_branch_sync_with_git	Indicates if the source branch should sync with git	boolean	None
destination_branch	The target branch	string	None

Request Generator Definition

Event request.generator_definition.check

Description: Sent to trigger Generators to run for a proposed change.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
generator_definition	The Generator Definition	N/A	None
branch_diff	The calculated diff between the two branches	N/A	None
proposed_change	The unique ID of the Proposed Change	string	None
source_branch	The source branch	string	None
source_branch_sync_with_git	Indicates if the source branch should sync with git	boolean	None
destination_branch	The target branch	string	None

Request Proposed Change

Event request.proposed_change.pipeline

Description: Sent request the start of a pipeline connected to a proposed change.

Priority: 5

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
proposed_change	The unique ID of the proposed change	string	None
source_branch	The source branch of the proposed change	string	None
source_branch_sync_with_git	Indicates if the source branch should sync with git	boolean	None
destination_branch	The destination branch of the proposed change	string	None
check_type	Can be used to restrict the pipeline to a specific type of job	N/A	all

Event request.proposed_change.refresh_artifacts

Description: Sent trigger the refresh of artifacts that are impacted by the proposed change.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
proposed_change	The unique ID of the Proposed Change	string	None
source_branch	The source branch of the proposed change	string	None
source_branch_sync_with_git	Indicates if the source branch should sync with git	boolean	None
destination_branch	The destination branch of the proposed change	string	None
branch_diff	The calculated diff between the two branches	N/A	None

Request Repository

Event request.repository.checks

Description: Sent to trigger the checks for a repository to be executed.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
proposed_change	The unique ID of the Proposed Change	string	None
repository	The unique ID of the Repository	string	None
source_branch	The source branch	string	None
target_branch	The target branch	string	None

Event request.repository.user_checks

Description: Sent to trigger the user defined checks on a repository.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
proposed_change	The unique ID of the Proposed Change	string	None
repository	The unique ID of the Repository	string	None
source_branch	The source branch	string	None
source_branch_sync_with_git	Indicates if the source branch should sync with git	boolean	None
target_branch	The target branch	string	None
branch_diff	The calculated diff between the two branches	N/A	None

Send Echo

Event send.echo.request

Description: Sent a echo request, i.e., ping message.

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
message	The message to send	string	None

Trigger Webhook

Event trigger.webhook.actions

Description: Triggers webhooks to be sent for the given action

Priority: 3

Key	Description	Type	Default Value
meta	Meta properties for the message	N/A	None
event_type	The event type	string	None
event_data	The webhook payload	object	None