Event Reference
Every outbound webhook event, generated from the OpenAPI document and grouped by family.
Every outbound webhook event, generated from the same OpenAPI document as the API reference and grouped by family: when it fires, the signed envelope and its headers, the data payload field by field, named examples, caveats and related events. Each family has an overview page carrying the shared narrative and the ability a token needs to subscribe an endpoint to its events, and one page per event; a row below opens the event's page.
ai.* events
The team's monthly AI budget approaching and reaching its cap. Read the overview.
ai.budget_warningThe month's spend crosses the budget's alert threshold.ai.budget_exhaustedThe month's spend reaches the cap.approval.* events
The life of an approval request: an artefact put up for approval, each approver's verdict, the outcome the verdicts settle, a request taken back, a request that ran past its time, and a change to how a project decides a kind of approval. Read the overview.
approval.requestedAn artefact is put up for approval.approval.decidedOne approver gives a verdict.approval.approvedA request carries.approval.rejectedAn approver rejects the request.approval.changes_requestedAn approver asks for changes.approval.withdrawnAn open request is taken back.approval.escalatedA pending request passes the time the policy allows.approval.policy_updatedA project changes how one kind of approval is decided.attachment.* events
The files pinned on a project's artefacts: a file uploaded and a file removed. Read the overview.
baseline.* events
The life of a project's baselines: a baseline added as a draft, its words or items changed, moved by hand, frozen by the team's approval, signed by the client, put back to an earlier version and deleted. Read the overview.
baseline.createdA baseline is added.baseline.updatedA draft baseline's words or records change.baseline.status_changedA baseline moves between its states.baseline.frozenThe team's approval froze a baseline.baseline.signed_offThe client signed a scope baseline.baseline.restoredAn earlier version of a draft baseline is put back.baseline.deletedA draft baseline is deleted.business_rule.* events
The lifecycle of a project's business rules: a rule added, changed, moved along its review lifecycle, put back to an earlier version and deleted. Read the overview.
business_rule.createdA rule is added.business_rule.updatedA rule's fields change.business_rule.status_changedA rule moves along its review lifecycle.business_rule.restoredAn earlier version of a rule is put back.business_rule.quality_reviewedA rule's quality is reviewed.business_rule.deletedA rule is deleted.change_request.* events
The life of a project's change requests: a request raised, its words or impact changed, moved along its lifecycle by hand or by the approval engine, read by Heimdall for its impact, put back to an earlier version and deleted. Read the overview.
change_request.createdA change request is raised.change_request.updatedA change request's fields change.change_request.status_changedA change request moves between its states.change_request.analysedHeimdall read a change request against its baseline.change_request.restoredAn earlier version of a change request is put back.change_request.deletedA change request that was never agreed is deleted.client.* events
The lifecycle of a client: creation, edits, archiving, restoring and deletion. Read the overview.
client.createdA client is added.client.updatedA client's fields change.client.archivedA client is archived.client.restoredAn archived client is restored.client.deletedA client that no project names is deleted.comment.* events
The conversations on a project's artefacts: a comment posted, edited, resolved, reopened and deleted. Read the overview.
comment.createdA comment is posted.comment.updatedA comment's words are rewritten.comment.resolvedThe first comment of a thread is marked resolved.comment.reopenedA resolved thread is marked open again.comment.deletedA comment is deleted.component.* events
The lifecycle of a project's components: creation, edits, archiving, restoring and deletion. Read the overview.
component.createdA component is added.component.updatedA component's fields change.component.archivedA component is archived.component.restoredAn archived component is restored.component.deletedA component no environment runs is deleted.council.* events
council.convenedcouncil.convenedcouncil.voice_spokecouncil.voice_spokecouncil.round_openedcouncil.round_openedcouncil.readycouncil.readycouncil.failedcouncil.failedcouncil.finding_acceptedcouncil.finding_acceptedcouncil.finding_dismissedcouncil.finding_dismisseddata_entity.* events
The lifecycle of a project's data dictionary: an entity created, changed, moved along its review, its fields replaced and the entity deleted. Read the overview.
data_entity.createdAn entity is created.data_entity.updatedAn entity's fields change.data_entity.status_changedAn entity moves along its review.data_entity.fields_changedThe entity's fields are replaced.data_entity.deletedAn entity is deleted.data_entity.restoredAn earlier version of a entity is put back.decision.* events
The lifecycle of a project's decisions: a decision added, changed, moved along its lifecycle, put back to an earlier version and deleted. Read the overview.
decision.createdA decision is added.decision.updatedA decision's fields change.decision.status_changedA decision moves along its lifecycle.decision.restoredAn earlier version of a decision is put back.decision.deletedA decision is deleted.design_reference.* events
The lifecycle of a project's design references: a link added, changed and removed. Read the overview.
design_reference.createdA reference is added.design_reference.updatedA reference's fields change.design_reference.deletedA reference is deleted.environment.* events
The lifecycle and the state of a project's environments: creation, edits, deletion, change freezes and the health the checks find. Read the overview.
environment.createdAn environment is added.environment.updatedAn environment's fields change.environment.deletedAn environment is deleted.environment.frozenA change freeze starts.environment.unfrozenA change freeze is lifted before it ends.environment.health_changedA check finds the environment in a different health than before.epic.* events
The lifecycle of a project's epics: an epic added, changed, moved along its lifecycle, put back to an earlier version and deleted. Read the overview.
epic.createdAn epic is added.epic.updatedAn epic's fields change.epic.status_changedAn epic moves along its lifecycle.epic.restoredAn earlier version of an epic is put back.epic.deletedAn epic is deleted.glossary_term.* events
The lifecycle of a project's glossary: a term added, changed, moved along its review and deleted. Read the overview.
glossary_term.createdA term is added.glossary_term.updatedA term's fields change.glossary_term.status_changedA term moves along its review.glossary_term.deletedA term is deleted.glossary_term.restoredAn earlier version of a term is put back.import.* events
The life of a brief import: a brief handed to Heimdall, read into suggestions or failed, discarded, and each suggestion accepted, rejected or merged by a person. Read the overview.
import.startedA brief is handed to Heimdall.import.readyHeimdall read the brief.import.failedThe reading failed.import.discardedA person dropped the batch.import.suggestion_acceptedA person accepted a suggestion.import.suggestion_rejectedA person rejected a suggestion, or dismissed a note.import.suggestion_mergedA person merged a suggestion into a record the project already held.improvement.* events
Heimdall's improvement sweep of a project's record: one event each time it ran, with what it proposed, took down and left waiting. Read the overview.
label.* events
A project's label vocabulary: a label added, rewritten and removed. Read the overview.
label.createdA word is added to the vocabulary.label.updatedA label's word, colour or note changes.label.deletedA label is removed.link.* events
The links between a project's artefacts: a link made and a link removed. Read the overview.
persona.* events
The lifecycle of a project's personas: creation, edits, archiving, restoring and deletion. Read the overview.
persona.createdA persona is added.persona.updatedA persona's fields change.persona.archivedA persona is archived.persona.restoredAn archived persona is restored.persona.deletedA persona is deleted.persona.version_restoredAn earlier version of a persona is put back.project.* events
The lifecycle of a project and its membership: creation, edits, status moves, archiving, restoring, deletion, and people joining or leaving it. Read the overview.
project.createdA project is created.project.updatedA project's own fields change.project.status_changedA project moves between lifecycle statuses.project.archivedA project is archived.project.restoredAn archived project is restored.project.deletedA project is deleted with everything under it.project.settings_changedOne or more of the project's settings change.project.member_addedA person gains a membership row on the project.project.member_removedA person's membership row on the project is removed.raid_item.* events
The lifecycle of a project's RAID log: a risk, an assumption, an issue or a dependency raised, changed, moved along its lifecycle, put back to an earlier version and deleted. Read the overview.
raid_item.createdAn item is raised.raid_item.updatedAn item's fields change.raid_item.status_changedAn item moves along its lifecycle.raid_item.restoredAn earlier version of an item is put back.raid_item.deletedAn item is deleted.repository.* events
The lifecycle of a project's repositories: registration, edits, disconnecting, reconnecting and deletion. Read the overview.
repository.createdA repository is registered.repository.updatedA repository's fields change.repository.disconnectedA repository is set aside.repository.reconnectedA disconnected repository is brought back.repository.deletedA repository is deleted.requirement.* events
The lifecycle of a project's requirements: a functional or non-functional requirement added, changed, moved along its review lifecycle, put back to an earlier version and deleted. Read the overview.
requirement.createdA requirement is added.requirement.updatedA requirement's fields change.requirement.status_changedA requirement moves along its review lifecycle.requirement.restoredAn earlier version of a requirement is put back.requirement.quality_reviewedA requirement's quality is reviewed.requirement.deletedA requirement is deleted.research.* events
The life of a research run: Heimdall asked to read a project's domain, done with notes and suggestions, or failed. Read the overview.
research.startedA person asks Heimdall to research the project.research.readyHeimdall finished the research.research.failedThe run failed.role.* events
Role creation, edits and deletion. Read the overview.
role.createdA role is created.role.updatedA role's name, description or permissions change.role.deletedA custom role is deleted.stakeholder.* events
The lifecycle of a project's stakeholders: who was added to the record, what changed about them and who was removed. Read the overview.
stakeholder.createdA stakeholder is added.stakeholder.updatedA stakeholder's fields change.stakeholder.deletedA stakeholder is removed.stakeholder.restoredAn earlier version of a stakeholder is put back.team.* events
Team creation, rename and deletion, and the comings and goings of the people in it. Read the overview.
team.createdA team is created.team.updatedA team is renamed.team.deletedA team with no projects is deleted.team.member_invitedAn invitation is sent to a staff member or a client guest.team.member_joinedAn invitee accepts and becomes a member.team.member_removedA member is removed from the team.team.member_role_changedA member moves to another of the team's roles.token.* events
Personal access token minting and revocation. Read the overview.
use_case.* events
The lifecycle of a project's use cases: a use case added, changed, moved along its review lifecycle, given new steps, put back to an earlier version and deleted. Read the overview.
use_case.createdA use case is added.use_case.updatedA use case's fields change.use_case.status_changedA use case moves along its review lifecycle.use_case.steps_changedA use case's steps are replaced.use_case.restoredAn earlier version of a use case is put back.use_case.deletedA use case is deleted.work_item.* events
The lifecycle of a project's work items: a story, task, sub-task, bug, spike or improvement added, changed, moved along its lifecycle, handed to a person, given new acceptance criteria, put back to an earlier version and deleted. Read the overview.
work_item.createdAn item is added.work_item.updatedAn item's fields change.work_item.transitionedAn item moves along its lifecycle.work_item.assignedAn item is handed to a person, or to nobody.work_item.criteria_changedAn item's acceptance criteria are replaced.work_item.restoredAn earlier version of an item is put back.work_item.quality_reviewedAn item's quality is reviewed.work_item.deletedAn item is deleted.How is this guide?
Last updated on