Infrahub events
This document provides detailed documentation for all events used in the Infrahub event system.
For more detailed explanations on how these events are used within Infrahub, see the Infrahub event topic.
Artifact events
Artifact Created Event
Type: infrahub.artifact.created Description: Event generated when an artifact has been created
Uses node_kind filter for webhooks: true
Key | Description |
---|---|
meta.branch | The branch on which originate this event |
meta.request_id | N/A |
meta.account_id | The ID of the account triggering this event |
meta.initiator_id | The worker identity of the initial sender of this message |
meta.context | The context used when originating this event |
meta.level | N/A |
meta.has_children | Indicates if this event might potentially have child events under it. |
meta.id | UUID of the event |
meta.parent | The UUID of the parent event if applicable |
meta.ancestors | Any event used to trigger this event |
node_id | The ID of the artifact |
artifact_definition_id | The ID of the artifact definition |
target_id | The ID of the target of the artifact |
target_kind | The kind of the target of the artifact |
checksum | The current checksum of the artifact |
checksum_previous | The previous checksum of the artifact |
storage_id | The current storage id of the artifact |
storage_id_previous | The previous storage id of the artifact |
Artifact Updated Event
Type: infrahub.artifact.updated Description: Event generated when an artifact has been updated
Uses node_kind filter for webhooks: true
Key | Description |
---|---|
meta.branch | The branch on which originate this event |
meta.request_id | N/A |
meta.account_id | The ID of the account triggering this event |
meta.initiator_id | The worker identity of the initial sender of this message |
meta.context | The context used when originating this event |
meta.level | N/A |
meta.has_children | Indicates if this event might potentially have child events under it. |
meta.id | UUID of the event |
meta.parent | The UUID of the parent event if applicable |
meta.ancestors | Any event used to trigger this event |
node_id | The ID of the artifact |
artifact_definition_id | The ID of the artifact definition |
target_id | The ID of the target of the artifact |
target_kind | The kind of the target of the artifact |
checksum | The current checksum of the artifact |
checksum_previous | The previous checksum of the artifact |
storage_id | The current storage id of the artifact |
storage_id_previous | The previous storage id of the artifact |
Branch events
Branch Created Event
Type: infrahub.branch.created Description: Event generated when a branch has been created
Uses node_kind filter for webhooks: false
Key | Description |
---|---|
meta.branch | The branch on which originate this event |
meta.request_id | N/A |
meta.account_id | The ID of the account triggering this event |
meta.initiator_id | The worker identity of the initial sender of this message |
meta.context | The context used when originating this event |
meta.level | N/A |
meta.has_children | Indicates if this event might potentially have child events under it. |
meta.id | UUID of the event |
meta.parent | The UUID of the parent event if applicable |
meta.ancestors | Any event used to trigger this event |
branch_name | The name of the branch |
branch_id | The ID of the branch |
sync_with_git | Indicates if the branch was extended to Git |
Branch Deleted Event
Type: infrahub.branch.deleted Description: Event generated when a branch has been deleted
Uses node_kind filter for webhooks: false
Key | Description |
---|---|
meta.branch | The branch on which originate this event |
meta.request_id | N/A |
meta.account_id | The ID of the account triggering this event |
meta.initiator_id | The worker identity of the initial sender of this message |
meta.context | The context used when originating this event |
meta.level | N/A |
meta.has_children | Indicates if this event might potentially have child events under it. |
meta.id | UUID of the event |
meta.parent | The UUID of the parent event if applicable |
meta.ancestors | Any event used to trigger this event |
branch_name | The name of the branch |
branch_id | The ID of the mutated node |
sync_with_git | Indicates if the branch was extended to Git |
Branch Merged Event
Type: infrahub.branch.merged Description: Event generated when a branch has been merged
Uses node_kind filter for webhooks: false
Key | Description |
---|---|
meta.branch | The branch on which originate this event |
meta.request_id | N/A |
meta.account_id | The ID of the account triggering this event |
meta.initiator_id | The worker identity of the initial sender of this message |
meta.context | The context used when originating this event |
meta.level | N/A |
meta.has_children | Indicates if this event might potentially have child events under it. |
meta.id | UUID of the event |
meta.parent | The UUID of the parent event if applicable |
meta.ancestors | Any event used to trigger this event |
branch_name | The name of the branch |
branch_id | The ID of the branch |
proposed_change_id | The ID of the proposed change that merged this branch if applicable |
Branch Rebased Event
Type: infrahub.branch.rebased Description: Event generated when a branch has been rebased
Uses node_kind filter for webhooks: false
Key | Description |
---|---|
meta.branch | The branch on which originate this event |
meta.request_id | N/A |
meta.account_id | The ID of the account triggering this event |
meta.initiator_id | The worker identity of the initial sender of this message |
meta.context | The context used when originating this event |
meta.level | N/A |
meta.has_children | Indicates if this event might potentially have child events under it. |
meta.id | UUID of the event |
meta.parent | The UUID of the parent event if applicable |
meta.ancestors | Any event used to trigger this event |
branch_id | The ID of the mutated node |
branch_name | The name of the branch |
Group events
Group Member Added Event
Type: infrahub.group.member_added Description: Event generated when a one or more members have been added to a group
Uses node_kind filter for webhooks: true
Key | Description |
---|---|
meta.branch | The branch on which originate this event |
meta.request_id | N/A |
meta.account_id | The ID of the account triggering this event |
meta.initiator_id | The worker identity of the initial sender of this message |
meta.context | The context used when originating this event |
meta.level | N/A |
meta.has_children | Indicates if this event might potentially have child events under it. |
meta.id | UUID of the event |
meta.parent | The UUID of the parent event if applicable |
meta.ancestors | Any event used to trigger this event |
kind | The type of updated group |
node_id | The ID of the updated group |
action | N/A |
members | Updated members during this event. |
ancestors | A list of groups that are ancestors of this group. |
Group Member Removed Event
Type: infrahub.group.member_removed Description: Event generated when a one or more members have been removed to a group
Uses node_kind filter for webhooks: true
Key | Description |
---|---|
meta.branch | The branch on which originate this event |
meta.request_id | N/A |
meta.account_id | The ID of the account triggering this event |
meta.initiator_id | The worker identity of the initial sender of this message |
meta.context | The context used when originating this event |
meta.level | N/A |
meta.has_children | Indicates if this event might potentially have child events under it. |
meta.id | UUID of the event |
meta.parent | The UUID of the parent event if applicable |
meta.ancestors | Any event used to trigger this event |
kind | The type of updated group |
node_id | The ID of the updated group |
action | N/A |
members | Updated members during this event. |
ancestors | A list of groups that are ancestors of this group. |
Node events
Node Created Event
Type: infrahub.node.created Description: Event generated when a node has been created
Uses node_kind filter for webhooks: true
Key | Description |
---|---|
meta.branch | The branch on which originate this event |
meta.request_id | N/A |
meta.account_id | The ID of the account triggering this event |
meta.initiator_id | The worker identity of the initial sender of this message |
meta.context | The context used when originating this event |
meta.level | N/A |
meta.has_children | Indicates if this event might potentially have child events under it. |
meta.id | UUID of the event |
meta.parent | The UUID of the parent event if applicable |
meta.ancestors | Any event used to trigger this event |
kind | The type of object modified |
node_id | The ID of the mutated node |
action | N/A |
changelog | Data on modified object |
fields | Fields provided in the mutation |
Node Deleted Event
Type: infrahub.node.deleted Description: Event generated when a node has been deleted
Uses node_kind filter for webhooks: true
Key | Description |
---|---|
meta.branch | The branch on which originate this event |
meta.request_id | N/A |
meta.account_id | The ID of the account triggering this event |
meta.initiator_id | The worker identity of the initial sender of this message |
meta.context | The context used when originating this event |
meta.level | N/A |
meta.has_children | Indicates if this event might potentially have child events under it. |
meta.id | UUID of the event |
meta.parent | The UUID of the parent event if applicable |
meta.ancestors | Any event used to trigger this event |
kind | The type of object modified |
node_id | The ID of the mutated node |
action | N/A |
changelog | Data on modified object |
fields | Fields provided in the mutation |
Node Updated Event
Type: infrahub.node.updated Description: Event generated when a node has been updated
Uses node_kind filter for webhooks: true
Key | Description |
---|---|
meta.branch | The branch on which originate this event |
meta.request_id | N/A |
meta.account_id | The ID of the account triggering this event |
meta.initiator_id | The worker identity of the initial sender of this message |
meta.context | The context used when originating this event |
meta.level | N/A |
meta.has_children | Indicates if this event might potentially have child events under it. |
meta.id | UUID of the event |
meta.parent | The UUID of the parent event if applicable |
meta.ancestors | Any event used to trigger this event |
kind | The type of object modified |
node_id | The ID of the mutated node |
action | N/A |
changelog | Data on modified object |
fields | Fields provided in the mutation |
Commit events
Commit Updated Event
Type: infrahub.repository.update_commit Description: Event generated when the the commit within a repository has been updated.
Uses node_kind filter for webhooks: false
Key | Description |
---|---|
meta.branch | The branch on which originate this event |
meta.request_id | N/A |
meta.account_id | The ID of the account triggering this event |
meta.initiator_id | The worker identity of the initial sender of this message |
meta.context | The context used when originating this event |
meta.level | N/A |
meta.has_children | Indicates if this event might potentially have child events under it. |
meta.id | UUID of the event |
meta.parent | The UUID of the parent event if applicable |
meta.ancestors | Any event used to trigger this event |
commit | The commit the repository was updated to |
repository_id | The ID of the repository |
repository_name | The name of the repository |
Validator events
Validator Failed Event
Type: infrahub.validator.failed Description: Event generated when an validator within a pipeline has completed successfully.
Uses node_kind filter for webhooks: true
Key | Description |
---|---|
meta.branch | The branch on which originate this event |
meta.request_id | N/A |
meta.account_id | The ID of the account triggering this event |
meta.initiator_id | The worker identity of the initial sender of this message |
meta.context | The context used when originating this event |
meta.level | N/A |
meta.has_children | Indicates if this event might potentially have child events under it. |
meta.id | UUID of the event |
meta.parent | The UUID of the parent event if applicable |
meta.ancestors | Any event used to trigger this event |
node_id | The ID of the validator |
kind | The kind of the validator |
proposed_change_id | The ID of the proposed change |
Validator Passed Event
Type: infrahub.validator.passed Description: Event generated when an validator within a pipeline has completed successfully.
Uses node_kind filter for webhooks: true
Key | Description |
---|---|
meta.branch | The branch on which originate this event |
meta.request_id | N/A |
meta.account_id | The ID of the account triggering this event |
meta.initiator_id | The worker identity of the initial sender of this message |
meta.context | The context used when originating this event |
meta.level | N/A |
meta.has_children | Indicates if this event might potentially have child events under it. |
meta.id | UUID of the event |
meta.parent | The UUID of the parent event if applicable |
meta.ancestors | Any event used to trigger this event |
node_id | The ID of the validator |
kind | The kind of the validator |
proposed_change_id | The ID of the proposed change |
Validator Started Event
Type: infrahub.validator.started Description: Event generated when an validator within a pipeline has started.
Uses node_kind filter for webhooks: true
Key | Description |
---|---|
meta.branch | The branch on which originate this event |
meta.request_id | N/A |
meta.account_id | The ID of the account triggering this event |
meta.initiator_id | The worker identity of the initial sender of this message |
meta.context | The context used when originating this event |
meta.level | N/A |
meta.has_children | Indicates if this event might potentially have child events under it. |
meta.id | UUID of the event |
meta.parent | The UUID of the parent event if applicable |
meta.ancestors | Any event used to trigger this event |
node_id | The ID of the validator |
kind | The kind of the validator |
proposed_change_id | The ID of the proposed change |
Schema events
Schema Updated Event
Type: infrahub.schema.updated Description: Event generated when the schema within a branch has been updated.
Uses node_kind filter for webhooks: false
Key | Description |
---|---|
meta.branch | The branch on which originate this event |
meta.request_id | N/A |
meta.account_id | The ID of the account triggering this event |
meta.initiator_id | The worker identity of the initial sender of this message |
meta.context | The context used when originating this event |
meta.level | N/A |
meta.has_children | Indicates if this event might potentially have child events under it. |
meta.id | UUID of the event |
meta.parent | The UUID of the parent event if applicable |
meta.ancestors | Any event used to trigger this event |
branch_name | The name of the branch |
schema_hash | Schema hash after the update |