Skip to main content

Event catalog

The event stream sends 14 entities. Each event names one entity, the id of what changed and an action; the envelope carries nothing else. Treat an event as a signal to refetch that item, and ignore any entity or action your client does not know: new ones may be added.

You only receive an event you are allowed to see. The Sent to column says who that is.

SectionentitySent to
TaskstaskMembers who can see that item
FeaturesfeatureMembers who can see that item
NodesnodeMembers who can see that item
Node ordersnode_orderYour organization's owners and admins
Live Castlive_castYour organization's owners and admins
Agent accountsaccountMembers who can see that item
CommandscommandMembers who can see that item
WorktreesworktreeEvery member of your organization
RunnersrunnerEvery member of your organization
Agent sessionssessionEvery member of your organization
Jaah AI balancetoken_walletEvery member of your organization
SchedulescronYour organization's owners and admins
Node groupsnode_groupYour organization's owners and admins
PipelinepipelineMembers who can see that item

Tasks​

A task or epic changed.

  • entity: task
  • Sent to: Members who can see that item.
  • id: The task's id — the number in its console address (/tasks/{id}).
  • deleted is not sent to you. The task is gone before access is checked. Refetch the list to notice a removal.
{"entity": "task", "id": 4916, "action": "created"}
ActionWhen it fires
createdA task or epic was created — by a person, a schedule or an agent.
updatedA task's fields were edited (title, body, settings).
titledJaah generated a title for the task.
taggedThe task's tags changed.
ratedSomeone rated the task's result.
outcome_judgedAn Owner or Admin confirmed, dismissed or added a defect link, so the task's outcome may have changed.
meteredA running task's usage and cost figures were updated.
prioritizedThe task's priority changed.
dependency_addedThe task was made to wait on another task.
dependency_removedA dependency was removed from the task.
control_messageThe control plane queued a message for the task's live runner, or the runner's node typed it in.
staleA task this one depends on changed, so its result may be out of date.
agent_filing_dedupedThe agent working on this task asked to file a task that already exists, so the existing one was kept.
set_stateSomeone set the task's state by hand, or a child's new state reactivated its epic.
runSomeone started or restarted the task, or Jaah reopened it to finish its pull request.
stopSomeone stopped the task.
resetSomeone reset the task to run again from the start.
completeSomeone marked the task complete.
draftThe task moved to Draft.
readyThe task moved to Ready — queued to start.
activeThe task moved to Active — an agent is working on it.
awaiting_responseThe task moved to Awaiting response — it asked a question someone must answer.
pausedThe task moved to Paused — its work stopped and is held for a resume.
system_failedThe task moved to Failed — Jaah used up its attempts.
doneThe task moved to Done.

Features​

A feature changed.

  • entity: feature
  • Sent to: Members who can see that item.
  • id: The feature's id.
  • deleted is not sent to you. The feature is gone before access is checked. Refetch the list to notice a removal.
{"entity": "feature", "id": "0199b3f2-4c1e-7a85-9d2b-6e0f1a7c3b48", "action": "created"}
ActionWhen it fires
createdA feature was created.
updatedA feature was edited.

Nodes​

A node changed: its settings, its health, or the work it reports.

  • entity: node
  • Sent to: Members who can see that item.
  • id: The node's id, or 0 when the list of nodes as a whole changed.
  • deleted is not sent to you. The node is gone before access is checked. Refetch the list to notice a removal.
{"entity": "node", "id": "0199a7d0-2e6b-7c14-8f3a-b51d9e04c672", "action": "upserted"}
ActionWhen it fires
upsertedA node was added, edited, or reported new state (health, capacity, agent accounts).

Node orders​

An Add-node order moved to its next step, finished, or failed.

  • entity: node_order
  • Sent to: Your organization's owners and admins.
  • id: The Add-node order's id.
{"entity": "node_order", "id": "0199b410-8a3c-7e29-a6d4-1f72c0b95e3d", "action": "upserted"}
ActionWhen it fires
upsertedAn order was placed, moved a step, finished, or failed. Fetch the order to read its step.

Live Cast​

A project's Live Cast settings, publication or a manual override on one of its tasks changed.

  • entity: live_cast
  • Sent to: Your organization's owners and admins.
  • id: The project's id.
{"entity": "live_cast", "id": 42, "action": "updated"}
ActionWhen it fires
updatedThe project's Live Cast checkbox, default or rules were saved.
publishedThe project's Live Cast was published.
unpublishedThe project's Live Cast was unpublished.
overrideA manual override on one of the project's tasks or attachments was set or cleared.

Agent accounts​

An agent account changed.

  • entity: account
  • Sent to: Members who can see that item.
  • id: The agent account's id, or 0 when the list of agent accounts as a whole changed.
  • deleted is not sent to you. The account is gone before access is checked. Refetch the list to notice a removal.
{"entity": "account", "id": "0199a812-5f07-7b6e-9c41-d3a08e6f2b17", "action": "upserted"}
ActionWhen it fires
upsertedAn agent account was added or edited, or its setup on a node finished.

Commands​

A command was sent to a node, and the command log has a new entry.

  • entity: command
  • Sent to: Members who can see that item.
  • id: The command log entry's id. You receive it when you can see the node the command ran on, or when it ran on no node.
{"entity": "command", "id": 5203, "action": "dispatched"}
ActionWhen it fires
dispatchedThe command was sent, but its node did not report back.
doneThe node ran the command.
failedThe command failed on its node.
rejectedThe node refused to run the command.

Worktrees​

Some worktree in your organization changed.

  • entity: worktree
  • Sent to: Every member of your organization.
  • id: Always 0: refetch your worktrees.
{"entity": "worktree", "id": 0, "action": "upserted"}
ActionWhen it fires
upsertedA worktree was claimed, released or changed state.
deletedA worktree was removed.

Runners​

An agent run started or ended on a worktree in your organization.

  • entity: runner
  • Sent to: Every member of your organization.
  • id: Always 0: refetch your worktrees and their runners.
{"entity": "runner", "id": 0, "action": "upserted"}
ActionWhen it fires
upsertedA node reported that an agent run started, ended or changed.

Agent sessions​

The list of agent sessions in your organization changed.

  • entity: session
  • Sent to: Every member of your organization.
  • id: Always 0: refetch the session list.
{"entity": "session", "id": 0, "action": "changed"}
ActionWhen it fires
changedAn agent session started, ended or was deleted.

Jaah AI balance​

Your organization's Jaah AI balance changed.

  • entity: token_wallet
  • Sent to: Every member of your organization.
  • id: Your organization's id.
{"entity": "token_wallet", "id": "01989c55-1b2d-7f40-8e6a-4c93d7a1f025", "action": "changed"}
ActionWhen it fires
changedCredit was added to or spent from the balance, or its settings changed.

Schedules​

An automation schedule changed.

  • entity: cron
  • Sent to: Your organization's owners and admins.
  • id: The schedule's id.
{"entity": "cron", "id": "0199b0c4-73e8-7d1a-b2f5-08e64a9c1d3b", "action": "upserted"}
ActionWhen it fires
upsertedA schedule was created, edited or moved to another folder.
deletedA schedule was deleted.

Node groups​

A node group changed.

  • entity: node_group
  • Sent to: Your organization's owners and admins.
  • id: The node group's id.
{"entity": "node_group", "id": "0199ae31-9d4f-7a62-8b07-e5c21f3d6a90", "action": "upserted"}
ActionWhen it fires
upsertedA node group was created or edited, or it added or removed nodes.
deletedA node group was deleted.

Pipeline​

Something moved on a project's pipeline: a task, a merge, a release, a pass, an approval, an archive or a setup save.

  • entity: pipeline
  • Sent to: Members who can see that item.
  • id: The project's id.
{"entity": "pipeline", "id": 42, "action": "changed"}
ActionWhen it fires
changedAnything a pipeline count, list or step shows changed. Fetch the project's pipeline view again.

Webhook event types​

An outgoing webhook endpoint subscribes to some of these types; each delivery's X-Jaah-Event header and body type name one. They are separate from the event stream above. An example delivery body is in What a delivery looks like.

TypeNameWhen it is sent
pingPingSent only when you press Send test on an endpoint, to check it receives and verifies deliveries.
task.createdTask createdA task was created in a project.
task.startedTask startedA task started running on a node.
task.awaiting_responseTask awaiting responseA task asked a question and is waiting for an answer.
task.doneTask doneA task finished.
task.failedTask failedA task failed and stopped running.
task.stoppedTask stoppedSomeone stopped a task.
pr.openedPull request openedA task opened a pull request.
pr.mergedPull request mergedA pull request a task opened was merged. Pull requests opened outside a task don't fire it.