Skip to content

API reference · events

The events

46 event types, each a CloudEvents 1.0 document with the schema below. A webhook subscription is sent the same document a poll of /integrations/triggers/{eventType} answers — one schema, two transports.

de.hubtask.automation.rule_run.failed.v1

An automation rule could not do what it says.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredrule_run/<id> - the run, which is what a consumer looks the rest up by.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject required
run_idstring
  • format: uuid
optionalThe run.
rule_idstring
  • format: uuid
optionalThe rule the run belongs to.
event_idstring or null
  • format: uuid
optionalThe event that started the run, when one did.
causation_depthinteger optionalHow far this run is from the act a person performed.
statusstring optionalABORTED_LOOP is the loop protection: the run was at the depth limit and did nothing.
error_codestring optionalThe message code the run ended on.
rule_disabledboolean optionalTrue when this failure was the one that took the rule past its consecutive-failure budget and switched it off.

de.hubtask.automation.rule_run.finished.v1

An automation rule finished a run without failing: it acted, or its conditions said no, or a throttle held it back.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredrule_run/<id> - the run, which is what a consumer looks the rest up by.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject required
run_idstring
  • format: uuid
optionalThe run.
rule_idstring
  • format: uuid
optionalThe rule the run belongs to.
event_idstring or null
  • format: uuid
optionalThe event that started the run, when one did.
causation_depthinteger optionalHow far this run is from the act a person performed.
statusstring optionalSUCCEEDED acted, SKIPPED had a condition answer false, THROTTLED was held back by the rule's own bound.
actions_succeededinteger optionalHow many actions ran and did what they say.
actions_failedinteger optionalHow many ran and refused.

de.hubtask.automation.rule_run.started.v1

An automation rule began a run.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredrule_run/<id> - the run, which is what a consumer looks the rest up by.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject required
run_idstring
  • format: uuid
optionalThe run.
rule_idstring
  • format: uuid
optionalThe rule the run belongs to.
event_idstring or null
  • format: uuid
optionalThe event that started the run, when one did.
causation_depthinteger optionalHow far this run is from the act a person performed.

de.hubtask.jumble.entry.converted.v1

A jumble entry became work: a conversion produced an item at a named destination, recorded the provenance on both sides (the entry's target, the item's origin_jumble_id), and settled the entry as PROCESSED - once; a second conversion of the same entry is refused.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredjumble_entry/<id> - the entry that was converted.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject required
idstring
  • format: uuid
optionalThe entry.
channelstring optionalHow it originally arrived.
target_item_idstring
  • format: uuid
optionalThe item the conversion produced - the other half of the provenance pair.
collection_idstring
  • format: uuid
optionalWhere the item was created.

de.hubtask.jumble.entry.received.v1

An entry arrived in the jumble.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredjumble_entry/<id> - the entry, which is what a consumer looks the rest up by.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject required
idstring
  • format: uuid
optionalThe entry.
channelstring optionalHow it arrived.
attachment_countinteger optionalHow many media objects it carries.
received_atstring
  • format: date-time
optional

de.hubtask.work.attachment.added.v1

An entry now carries a file.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredThe reference rather than a snapshot of the entry, for the reason the label events give: a set is not a field, and an entry snapshot would have to carry the whole set to be useful.
item_idstring
  • format: uuid
optional
collection_idstring
  • format: uuid
optionalThe collection the entry belongs to, which is where the permission to see the attachment is resolved from.
media_idstring
  • format: uuid
optionalThe media object that was attached.

de.hubtask.work.attachment.removed.v1

An entry no longer carries a file.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredThe reference rather than a snapshot of the entry, exactly as the addition carries it.
item_idstring
  • format: uuid
optional
collection_idstring
  • format: uuid
optionalThe collection the entry belongs to, which is where the permission to see the attachment is resolved from.
media_idstring
  • format: uuid
optionalThe media object that was detached.

de.hubtask.work.bucket.created.v1

A column was added to a collection's board.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredA snapshot of the bucket as it was created.
idstring
  • format: uuid
optional
collection_idstring
  • format: uuid
optionalThe collection whose board this column belongs to.
namestring optionalAt most 120 characters, on one line, unique in the collection without regard to case or accents.
order_keystring optionalThe rank on the board: a fractional index, not a number.
wip_limitinteger or null optionalHow many entries the people using this board agreed to have in the column at once, or null for no limit.
is_done_bucketboolean optionalWhether this column means finished.
color_tokenstring or null optionalA theme token rather than a colour value, so that a client can render it in its own palette.
deleted_atstring or null
  • format: date-time
optionalWhen the column was taken off the board.
versioninteger optional

de.hubtask.work.bucket.deleted.v1

A column was taken off a collection's board, and its entries moved.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredA snapshot of the column as it was deleted, and what became of the entries that were in it.
idstring
  • format: uuid
optional
collection_idstring
  • format: uuid
optionalThe collection whose board this column belongs to.
namestring optionalAt most 120 characters, on one line, unique in the collection without regard to case or accents.
order_keystring optionalThe rank on the board: a fractional index, not a number.
wip_limitinteger or null optionalHow many entries the people using this board agreed to have in the column at once, or null for no limit.
is_done_bucketboolean optionalWhether this column means finished.
color_tokenstring or null optionalA theme token rather than a colour value, so that a client can render it in its own palette.
deleted_atstring or null
  • format: date-time
optionalWhen the column was taken off the board.
versioninteger optional
target_bucket_idstring or null
  • format: uuid
optionalThe column the entries moved to - the leftmost remaining one.
moved_itemsinteger optionalHow many entries were moved.

de.hubtask.work.bucket.reordered.v1

A column moved along its board.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredA snapshot of the column as it now stands, and the change set beside it: the snapshot is what the column is, and the change set is what a field change trigger is written against.
idstring
  • format: uuid
optional
collection_idstring
  • format: uuid
optionalThe collection whose board this column belongs to.
namestring optionalAt most 120 characters, on one line, unique in the collection without regard to case or accents.
order_keystring optionalThe rank on the board: a fractional index, not a number.
wip_limitinteger or null optionalHow many entries the people using this board agreed to have in the column at once, or null for no limit.
is_done_bucketboolean optionalWhether this column means finished.
color_tokenstring or null optionalA theme token rather than a colour value, so that a client can render it in its own palette.
deleted_atstring or null
  • format: date-time
optionalWhen the column was taken off the board.
versioninteger optional
change_setobject optionalOne entry per field that moved, each with the value on either side.

de.hubtask.work.bucket.updated.v1

A column's own fields changed.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredA snapshot of the column as it now stands, and the change set beside it: the snapshot is what the column is, and the change set is what a field change trigger is written against.
idstring
  • format: uuid
optional
collection_idstring
  • format: uuid
optionalThe collection whose board this column belongs to.
namestring optionalAt most 120 characters, on one line, unique in the collection without regard to case or accents.
order_keystring optionalThe rank on the board: a fractional index, not a number.
wip_limitinteger or null optionalHow many entries the people using this board agreed to have in the column at once, or null for no limit.
is_done_bucketboolean optionalWhether this column means finished.
color_tokenstring or null optionalA theme token rather than a colour value, so that a client can render it in its own palette.
deleted_atstring or null
  • format: date-time
optionalWhen the column was taken off the board.
versioninteger optional
change_setobject optionalOne entry per field that moved, each with the value on either side.

de.hubtask.work.comment.created.v1

A new contribution to an entry's discussion.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredThe reference rather than a snapshot of the entry, which is what the assignment and member events have in common with the label pair: a set is not a field.
idstring
  • format: uuid
optional
item_idstring
  • format: uuid
optionalThe entry the discussion belongs to - what a rule reads the rest from.
collection_idstring
  • format: uuid
optional
author_idstring
  • format: uuid
optionalWho wrote the comment - not necessarily who acted: an administrator may edit or delete somebody else's words, and the actor attribute says who did.
parent_comment_idstring or null
  • format: uuid
optionalThe comment this one replies to, null for a top-level comment.
bodystring or null optionalThe text, null exactly when deleted_at is set: a tombstone keeps the comment's identity and loses its words.
created_atstring
  • format: date-time
optional
edited_atstring or null
  • format: date-time
optional
deleted_atstring or null
  • format: date-time
optional
versioninteger optional

de.hubtask.work.comment.deleted.v1

A comment's tombstone: identity, author and timestamps kept so a reply does not dangle, the body null because the text is gone rather than hidden.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredThe reference rather than a snapshot of the entry, which is what the assignment and member events have in common with the label pair: a set is not a field.
idstring
  • format: uuid
optional
item_idstring
  • format: uuid
optionalThe entry the discussion belongs to - what a rule reads the rest from.
collection_idstring
  • format: uuid
optional
author_idstring
  • format: uuid
optionalWho wrote the comment - not necessarily who acted: an administrator may edit or delete somebody else's words, and the actor attribute says who did.
parent_comment_idstring or null
  • format: uuid
optionalThe comment this one replies to, null for a top-level comment.
bodystring or null optionalThe text, null exactly when deleted_at is set: a tombstone keeps the comment's identity and loses its words.
created_atstring
  • format: date-time
optional
edited_atstring or null
  • format: date-time
optional
deleted_atstring or null
  • format: date-time
optional
versioninteger optional

de.hubtask.work.comment.updated.v1

A comment's text was rewritten.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredThe reference rather than a snapshot of the entry, which is what the assignment and member events have in common with the label pair: a set is not a field.
idstring
  • format: uuid
optional
item_idstring
  • format: uuid
optionalThe entry the discussion belongs to - what a rule reads the rest from.
collection_idstring
  • format: uuid
optional
author_idstring
  • format: uuid
optionalWho wrote the comment - not necessarily who acted: an administrator may edit or delete somebody else's words, and the actor attribute says who did.
parent_comment_idstring or null
  • format: uuid
optionalThe comment this one replies to, null for a top-level comment.
bodystring or null optionalThe text, null exactly when deleted_at is set: a tombstone keeps the comment's identity and loses its words.
created_atstring
  • format: date-time
optional
edited_atstring or null
  • format: date-time
optional
deleted_atstring or null
  • format: date-time
optional
versioninteger optional

de.hubtask.work.container.archived.v1

A container is read-only, and everything under it with it.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredA snapshot of the container as it now stands, archived_at carrying the moment.
idstring
  • format: uuid
optional
typestring optional
parent_idstring or null
  • format: uuid
optionalThe hub a collection sits in; null for a hub.
namestring optional
descriptionstring optional
iconstring optional
color_tokenstring optionalA theme token rather than a colour value, so that a client can render it in its own palette.
order_keystring optionalThe rank among the siblings: a fractional index, not a number.
completion_policystring optionalWhether a child's completion propagates upwards.
auto_assignobject or null optionalThe collection's automatic assignment policy, null for none.
archived_atstring or null
  • format: date-time
optionalWhen this container was archived in its own right.
effective_archivedboolean optionalWhether the container is read-only: archived itself, or sitting in an archived hub.
created_atstring
  • format: date-time
optional
created_bystring
  • format: uuid
optional
updated_atstring
  • format: date-time
optional
versioninteger optional
privateboolean optionalWhether the hub is private: reached only by people holding a role on it or below it.

de.hubtask.work.container.created.v1

A hub or a collection was created.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredA snapshot of the container as it was created.
idstring
  • format: uuid
optional
typestring optional
parent_idstring or null
  • format: uuid
optionalThe hub a collection sits in; null for a hub.
namestring optional
descriptionstring optional
iconstring optional
color_tokenstring optionalA theme token rather than a colour value, so that a client can render it in its own palette.
order_keystring optionalThe rank among the siblings: a fractional index, not a number.
completion_policystring optionalWhether a child's completion propagates upwards.
auto_assignobject or null optionalThe collection's automatic assignment policy, null for none.
archived_atstring or null
  • format: date-time
optionalWhen this container was archived in its own right.
effective_archivedboolean optionalWhether the container is read-only: archived itself, or sitting in an archived hub.
created_atstring
  • format: date-time
optional
created_bystring
  • format: uuid
optional
updated_atstring
  • format: date-time
optional
versioninteger optional
privateboolean optionalWhether the hub is private: reached only by people holding a role on it or below it.

de.hubtask.work.container.deleted.v1

A container and everything under it are in the trash: a soft delete waiting out its retention period.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredA snapshot of the container as it now stands, with the deletion's own fields and how much went with it.
idstring
  • format: uuid
optional
typestring optional
parent_idstring or null
  • format: uuid
optionalThe hub a collection sits in; null for a hub.
namestring optional
descriptionstring optional
iconstring optional
color_tokenstring optionalA theme token rather than a colour value, so that a client can render it in its own palette.
order_keystring optionalThe rank among the siblings: a fractional index, not a number.
completion_policystring optionalWhether a child's completion propagates upwards.
auto_assignobject or null optionalThe collection's automatic assignment policy, null for none.
archived_atstring or null
  • format: date-time
optionalWhen this container was archived in its own right.
effective_archivedboolean optionalWhether the container is read-only: archived itself, or sitting in an archived hub.
created_atstring
  • format: date-time
optional
created_bystring
  • format: uuid
optional
updated_atstring
  • format: date-time
optional
privateboolean optionalWhether the hub is private: reached only by people holding a role on it or below it.
versioninteger optional
deleted_atstring or null
  • format: date-time
optionalWhen the entry went into the trash.
trash_batch_idstring or null
  • format: uuid
optionalThe deletion every row of one act shares.
collectionsinteger optionalHow many collections the act took with it.
itemsinteger optionalHow many entries the act took with it, at every level.

de.hubtask.work.container.moved.v1

A collection sits in a different hub, or at a different rank in the same one.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredA snapshot of the collection where it now sits, with the hub it came from beside it.
idstring
  • format: uuid
optional
typestring optional
parent_idstring or null
  • format: uuid
optionalThe hub a collection sits in; null for a hub.
namestring optional
descriptionstring optional
iconstring optional
color_tokenstring optionalA theme token rather than a colour value, so that a client can render it in its own palette.
order_keystring optionalThe rank among the siblings: a fractional index, not a number.
completion_policystring optionalWhether a child's completion propagates upwards.
auto_assignobject or null optionalThe collection's automatic assignment policy, null for none.
archived_atstring or null
  • format: date-time
optionalWhen this container was archived in its own right.
effective_archivedboolean optionalWhether the container is read-only: archived itself, or sitting in an archived hub.
created_atstring
  • format: date-time
optional
created_bystring
  • format: uuid
optional
updated_atstring
  • format: date-time
optional
privateboolean optionalWhether the hub is private: reached only by people holding a role on it or below it.
versioninteger optional
from_parent_idstring or null
  • format: uuid
optionalThe hub the collection came out of.

de.hubtask.work.container.policies_updated.v1

A collection works differently now - today, whether a child's completion propagates upwards.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredA snapshot of the collection as it now stands, and the change set beside it.
idstring
  • format: uuid
optional
typestring optional
parent_idstring or null
  • format: uuid
optionalThe hub a collection sits in; null for a hub.
namestring optional
descriptionstring optional
iconstring optional
color_tokenstring optionalA theme token rather than a colour value, so that a client can render it in its own palette.
order_keystring optionalThe rank among the siblings: a fractional index, not a number.
completion_policystring optionalWhether a child's completion propagates upwards.
auto_assignobject or null optionalThe collection's automatic assignment policy, null for none.
archived_atstring or null
  • format: date-time
optionalWhen this container was archived in its own right.
effective_archivedboolean optionalWhether the container is read-only: archived itself, or sitting in an archived hub.
created_atstring
  • format: date-time
optional
created_bystring
  • format: uuid
optional
updated_atstring
  • format: date-time
optional
privateboolean optionalWhether the hub is private: reached only by people holding a role on it or below it.
versioninteger optional
change_setobject optionalThe fields that moved, each with the value on both sides.

de.hubtask.work.container.renamed.v1

A container's own descriptive fields changed: what it is called, and how it is shown.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredA snapshot of the container as it now stands, and the change set beside it.
idstring
  • format: uuid
optional
typestring optional
parent_idstring or null
  • format: uuid
optionalThe hub a collection sits in; null for a hub.
namestring optional
descriptionstring optional
iconstring optional
color_tokenstring optionalA theme token rather than a colour value, so that a client can render it in its own palette.
order_keystring optionalThe rank among the siblings: a fractional index, not a number.
completion_policystring optionalWhether a child's completion propagates upwards.
auto_assignobject or null optionalThe collection's automatic assignment policy, null for none.
archived_atstring or null
  • format: date-time
optionalWhen this container was archived in its own right.
effective_archivedboolean optionalWhether the container is read-only: archived itself, or sitting in an archived hub.
created_atstring
  • format: date-time
optional
created_bystring
  • format: uuid
optional
updated_atstring
  • format: date-time
optional
privateboolean optionalWhether the hub is private: reached only by people holding a role on it or below it.
versioninteger optional
change_setobject optionalThe fields that moved, each with the value on both sides.

de.hubtask.work.container.restored.v1

A container's deletion has been reversed, whole.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredA snapshot of the container as it now stands, deleted_at null again, with how much came back.
idstring
  • format: uuid
optional
typestring optional
parent_idstring or null
  • format: uuid
optionalThe hub a collection sits in; null for a hub.
namestring optional
descriptionstring optional
iconstring optional
color_tokenstring optionalA theme token rather than a colour value, so that a client can render it in its own palette.
order_keystring optionalThe rank among the siblings: a fractional index, not a number.
completion_policystring optionalWhether a child's completion propagates upwards.
auto_assignobject or null optionalThe collection's automatic assignment policy, null for none.
archived_atstring or null
  • format: date-time
optionalWhen this container was archived in its own right.
effective_archivedboolean optionalWhether the container is read-only: archived itself, or sitting in an archived hub.
created_atstring
  • format: date-time
optional
created_bystring
  • format: uuid
optional
updated_atstring
  • format: date-time
optional
privateboolean optionalWhether the hub is private: reached only by people holding a role on it or below it.
versioninteger optional
deleted_atstring or null
  • format: date-time
optionalWhen the entry went into the trash.
trash_batch_idstring or null
  • format: uuid
optionalThe deletion every row of one act shares.
collectionsinteger optionalHow many collections the act took with it.
itemsinteger optionalHow many entries the act took with it, at every level.

de.hubtask.work.container.unarchived.v1

A container is writable again.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredA snapshot of the container as it now stands, archived_at back to null.
idstring
  • format: uuid
optional
typestring optional
parent_idstring or null
  • format: uuid
optionalThe hub a collection sits in; null for a hub.
namestring optional
descriptionstring optional
iconstring optional
color_tokenstring optionalA theme token rather than a colour value, so that a client can render it in its own palette.
order_keystring optionalThe rank among the siblings: a fractional index, not a number.
completion_policystring optionalWhether a child's completion propagates upwards.
auto_assignobject or null optionalThe collection's automatic assignment policy, null for none.
archived_atstring or null
  • format: date-time
optionalWhen this container was archived in its own right.
effective_archivedboolean optionalWhether the container is read-only: archived itself, or sitting in an archived hub.
created_atstring
  • format: date-time
optional
created_bystring
  • format: uuid
optional
updated_atstring
  • format: date-time
optional
privateboolean optionalWhether the hub is private: reached only by people holding a role on it or below it.
versioninteger optional

de.hubtask.work.item.archived.v1

An entry is kept and read-only.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredA snapshot of the entry as it now stands, archived_at carrying the moment.
idstring
  • format: uuid
optional
typestring optionalThe level.
collection_idstring
  • format: uuid
optionalThe collection the item belongs to.
parent_idstring or null
  • format: uuid
optionalThe item above; null for one that sits directly under the collection.
pathstring optionalThe materialised path, /<id>/<id>/…/, including the item itself and closed by a separator.
depthinteger optionalThe level below the collection, counting from 1.
titlestring optional
notesstring optionalMarkdown, unrendered by the server.
completionobject optionalThe done/open state.
order_keystring optionalThe rank among the siblings: a fractional index, not a number.
created_atstring
  • format: date-time
optional
created_bystring
  • format: uuid
optional
versioninteger optional
updated_atstring
  • format: date-time
optionalWhen the item last changed - the instant of this completion change.
archived_atstring or null
  • format: date-time
optionalWhen the entry was archived: kept, and read-only.
deleted_atstring or null
  • format: date-time
optionalWhen the entry went into the trash.
trash_batch_idstring or null
  • format: uuid
optionalThe deletion every row of one act shares.

de.hubtask.work.item.assigned.v1

An entry is on somebody.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredThe reference rather than a snapshot of the entry, which is what the assignment and member events have in common with the label pair: a set is not a field.
item_idstring
  • format: uuid
optional
collection_idstring
  • format: uuid
optionalThe collection the entry belongs to, and the one an actor's permission to see it is judged against.
assignee_idstring
  • format: uuid
optionalThe account the entry is now assigned to.
strategystring optionalThe policy strategy that chose the assignee, present exactly when automatic assignment did the choosing.

de.hubtask.work.item.completed.v1

A task, a work package or an activity was completed.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredA snapshot of the item as it now stands, in the field names of the API (schema WorkItem), so that a webhook payload and a REST response describe the same object in the same words.
idstring
  • format: uuid
optional
typestring optionalThe level.
collection_idstring
  • format: uuid
optionalThe collection the item belongs to.
parent_idstring or null
  • format: uuid
optionalThe item above; null for one that sits directly under the collection.
pathstring optionalThe materialised path, /<id>/<id>/…/, including the item itself and closed by a separator.
depthinteger optionalThe level below the collection, counting from 1.
titlestring optional
notesstring optionalMarkdown, unrendered by the server.
completionobject optionalThe done state.
order_keystring optionalThe rank among the siblings: a fractional index, not a number.
created_atstring
  • format: date-time
optional
created_bystring
  • format: uuid
optional
versioninteger optional
updated_atstring
  • format: date-time
optionalWhen the item last changed - the instant of this completion change.

de.hubtask.work.item.created.v1

A task, a work package or an activity was created.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredA snapshot of the item as it was created, in the field names of the API (schema WorkItem), so that a webhook payload and a REST response describe the same object in the same words.
idstring
  • format: uuid
optional
typestring optionalThe level.
collection_idstring
  • format: uuid
optionalThe collection the item belongs to.
parent_idstring or null
  • format: uuid
optionalThe item above; null for one that sits directly under the collection.
pathstring optionalThe materialised path, /<id>/<id>/…/, including the item itself and closed by a separator.
depthinteger optionalThe level below the collection, counting from 1.
titlestring optional
notesstring optionalMarkdown, unrendered by the server.
completionobject optionalThe done/open state.
order_keystring optionalThe rank among the siblings: a fractional index, not a number.
created_atstring
  • format: date-time
optional
created_bystring
  • format: uuid
optional
versioninteger optional
updated_atstring
  • format: date-time
optionalWhen the item last changed.

de.hubtask.work.item.due_changed.v1

An entry's due date moved: set, moved to another moment, or cleared.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredBoth sides of the move rather than a snapshot, which is what the scheduler and the calendar feed react to: a relative reminder follows new_due_at, and a consumer that only saw the new value could not tell a set from a move.
item_idstring
  • format: uuid
optional
collection_idstring
  • format: uuid
optionalThe collection the entry belongs to, and the one an actor's permission to see it is judged against.
old_due_atstring
  • format: date-time
optionalRFC 3339 in UTC.
new_due_atstring
  • format: date-time
optionalRFC 3339 in UTC.
due_date_onlyboolean optionalTrue for an all-day due date: new_due_at is read as a date in time_zone, never as an instant.
time_zonestring optionalThe IANA zone the due date is local to, present when one was stored.

de.hubtask.work.item.due_soon.v1

An entry's due date is approaching: the scheduler saw it cross the lead in threshold_spec, and says so once per due date.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredWhat is due and how soon.
item_idstring
  • format: uuid
optional
collection_idstring
  • format: uuid
optionalThe collection the entry belongs to, and the one an actor's permission to see it is judged against.
due_atstring
  • format: date-time
optionalThe due date this announcement is about, RFC 3339 in UTC.
due_date_onlyboolean optionalTrue for an all-day due date: due_at is read as a date in time_zone, never as an instant.
time_zonestring optionalThe IANA zone the due date is local to, present when one was stored.
threshold_specstring optionalThe lead the entry crossed, as an ISO-8601 duration - PT24H in this version.

de.hubtask.work.item.label_added.v1

An entry now carries a label.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredThe reference rather than a snapshot of the entry, which is the one place this system does not send one: a set is not a field.
item_idstring
  • format: uuid
optional
collection_idstring
  • format: uuid
optionalThe collection the entry belongs to, and the one whose vocabulary the label comes from.
label_idstring
  • format: uuid
optionalThe label that was added or removed.

de.hubtask.work.item.label_removed.v1

An entry no longer carries a label.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredThe reference rather than a snapshot of the entry, which is the one place this system does not send one: a set is not a field.
item_idstring
  • format: uuid
optional
collection_idstring
  • format: uuid
optionalThe collection the entry belongs to, and the one whose vocabulary the label comes from.
label_idstring
  • format: uuid
optionalThe label that was added or removed.

de.hubtask.work.item.member_added.v1

An account is on an entry's member list.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredThe reference rather than a snapshot of the entry, which is what the assignment and member events have in common with the label pair: a set is not a field.
item_idstring
  • format: uuid
optional
collection_idstring
  • format: uuid
optionalThe collection the entry belongs to, and the one an actor's permission to see it is judged against.
account_idstring
  • format: uuid
optionalThe account that was added or removed.

de.hubtask.work.item.member_removed.v1

An account is off an entry's member list.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredThe reference rather than a snapshot of the entry, which is what the assignment and member events have in common with the label pair: a set is not a field.
item_idstring
  • format: uuid
optional
collection_idstring
  • format: uuid
optionalThe collection the entry belongs to, and the one an actor's permission to see it is judged against.
account_idstring
  • format: uuid
optionalThe account that was added or removed.

de.hubtask.work.item.moved.v1

An item sits somewhere else: under a different parent, in a different collection, or at a different rank among the same siblings.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredThe item as it now stands, in the field names of the API (schema WorkItem), plus where it came from.
idstring
  • format: uuid
optional
typestring optionalThe level.
collection_idstring
  • format: uuid
optionalThe collection the item belongs to.
parent_idstring or null
  • format: uuid
optionalThe item above; null for one that sits directly under the collection.
pathstring optionalThe materialised path, /<id>/<id>/…/, including the item itself and closed by a separator.
depthinteger optionalThe level below the collection, counting from 1.
titlestring optional
notesstring optionalMarkdown, unrendered by the server.
completionobject optionalThe done/open state.
order_keystring optionalThe rank among the siblings: a fractional index, not a number.
created_atstring
  • format: date-time
optional
created_bystring
  • format: uuid
optional
versioninteger optional
updated_atstring
  • format: date-time
optionalWhen the item last changed - the instant of this move.
from_parent_idstring or null
  • format: uuid
optionalThe item it sat under before, null if it sat directly in a collection.
to_parent_idstring or null
  • format: uuid
optionalThe item it sits under now, null for the top level of a collection.
from_pathstring optionalThe materialised path before the move.
from_collection_idstring or null
  • format: uuid
optionalThe collection it was in before, set only when the move crossed collections.
from_bucket_idstring or null
  • format: uuid
optionalThe column of the board it sat in before, null if it was on none.
to_bucket_idstring or null
  • format: uuid
optionalThe column it sits in now, null for none.

de.hubtask.work.item.overdue.v1

An entry's due date has passed with the work not done, announced once per due date.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredWhat was due and when.
item_idstring
  • format: uuid
optional
collection_idstring
  • format: uuid
optionalThe collection the entry belongs to, and the one an actor's permission to see it is judged against.
due_atstring
  • format: date-time
optionalThe due date this announcement is about, RFC 3339 in UTC.
due_date_onlyboolean optionalTrue for an all-day due date: due_at is read as a date in time_zone, never as an instant.
time_zonestring optionalThe IANA zone the due date is local to, present when one was stored.
threshold_specstring optionalPT0S: the threshold of this announcement is the moment itself.

de.hubtask.work.item.purged.v1

An entry is gone for good.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredWhat is left to say about an entry that no longer exists.
idstring
  • format: uuid
optional
typestring optional
collection_idstring
  • format: uuid
optional
pathstring optionalThe materialised path the entry had.
purged_atstring
  • format: date-time
optional
reasonstring optionalWhether a person asked for this - emptying a trash, purging one entry - or the tenant's retention policy did.

de.hubtask.work.item.reopened.v1

A completed task, work package or activity is open again.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredA snapshot of the item as it now stands, in the field names of the API (schema WorkItem), so that a webhook payload and a REST response describe the same object in the same words.
idstring
  • format: uuid
optional
typestring optionalThe level.
collection_idstring
  • format: uuid
optionalThe collection the item belongs to.
parent_idstring or null
  • format: uuid
optionalThe item above; null for one that sits directly under the collection.
pathstring optionalThe materialised path, /<id>/<id>/…/, including the item itself and closed by a separator.
depthinteger optionalThe level below the collection, counting from 1.
titlestring optional
notesstring optionalMarkdown, unrendered by the server.
completionobject optionalThe done state.
order_keystring optionalThe rank among the siblings: a fractional index, not a number.
created_atstring
  • format: date-time
optional
created_bystring
  • format: uuid
optional
versioninteger optional
updated_atstring
  • format: date-time
optionalWhen the item last changed - the instant of this completion change.

de.hubtask.work.item.restored.v1

A deletion has been reversed, whole.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredA snapshot of the entry as it now stands, deleted_at null again, with how much came back.
idstring
  • format: uuid
optional
typestring optionalThe level.
collection_idstring
  • format: uuid
optionalThe collection the item belongs to.
parent_idstring or null
  • format: uuid
optionalThe item above; null for one that sits directly under the collection.
pathstring optionalThe materialised path, /<id>/<id>/…/, including the item itself and closed by a separator.
depthinteger optionalThe level below the collection, counting from 1.
titlestring optional
notesstring optionalMarkdown, unrendered by the server.
completionobject optionalThe done/open state.
order_keystring optionalThe rank among the siblings: a fractional index, not a number.
created_atstring
  • format: date-time
optional
created_bystring
  • format: uuid
optional
versioninteger optional
updated_atstring
  • format: date-time
optionalWhen the item last changed - the instant of this completion change.
archived_atstring or null
  • format: date-time
optionalWhen the entry was archived: kept, and read-only.
deleted_atstring or null
  • format: date-time
optionalWhen the entry went into the trash.
trash_batch_idstring or null
  • format: uuid
optionalThe deletion every row of one act shares.
subtree_sizeinteger optionalHow many rows the act touched, this entry included.

de.hubtask.work.item.trashed.v1

An entry and everything under it are in the trash: a soft delete waiting out its retention period, reversible until the retention job removes it for good.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredA snapshot of the entry as it now stands, with the deletion's own fields: when it went in, which act it belongs to, and how much went with it.
idstring
  • format: uuid
optional
typestring optionalThe level.
collection_idstring
  • format: uuid
optionalThe collection the item belongs to.
parent_idstring or null
  • format: uuid
optionalThe item above; null for one that sits directly under the collection.
pathstring optionalThe materialised path, /<id>/<id>/…/, including the item itself and closed by a separator.
depthinteger optionalThe level below the collection, counting from 1.
titlestring optional
notesstring optionalMarkdown, unrendered by the server.
completionobject optionalThe done/open state.
order_keystring optionalThe rank among the siblings: a fractional index, not a number.
created_atstring
  • format: date-time
optional
created_bystring
  • format: uuid
optional
versioninteger optional
updated_atstring
  • format: date-time
optionalWhen the item last changed - the instant of this completion change.
archived_atstring or null
  • format: date-time
optionalWhen the entry was archived: kept, and read-only.
deleted_atstring or null
  • format: date-time
optionalWhen the entry went into the trash.
trash_batch_idstring or null
  • format: uuid
optionalThe deletion every row of one act shares.
subtree_sizeinteger optionalHow many rows the act touched, this entry included.

de.hubtask.work.item.unarchived.v1

An archived entry is writable again.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredA snapshot of the entry as it now stands, archived_at null again.
idstring
  • format: uuid
optional
typestring optionalThe level.
collection_idstring
  • format: uuid
optionalThe collection the item belongs to.
parent_idstring or null
  • format: uuid
optionalThe item above; null for one that sits directly under the collection.
pathstring optionalThe materialised path, /<id>/<id>/…/, including the item itself and closed by a separator.
depthinteger optionalThe level below the collection, counting from 1.
titlestring optional
notesstring optionalMarkdown, unrendered by the server.
completionobject optionalThe done/open state.
order_keystring optionalThe rank among the siblings: a fractional index, not a number.
created_atstring
  • format: date-time
optional
created_bystring
  • format: uuid
optional
versioninteger optional
updated_atstring
  • format: date-time
optionalWhen the item last changed - the instant of this completion change.
archived_atstring or null
  • format: date-time
optionalWhen the entry was archived: kept, and read-only.
deleted_atstring or null
  • format: date-time
optionalWhen the entry went into the trash.
trash_batch_idstring or null
  • format: uuid
optionalThe deletion every row of one act shares.

de.hubtask.work.item.unassigned.v1

An entry is on nobody, and this is who it was.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredThe reference rather than a snapshot of the entry, which is what the assignment and member events have in common with the label pair: a set is not a field.
item_idstring
  • format: uuid
optional
collection_idstring
  • format: uuid
optionalThe collection the entry belongs to, and the one an actor's permission to see it is judged against.
assignee_idstring
  • format: uuid
optionalThe account the entry was assigned to until now.

de.hubtask.work.item.updated.v1

An item's own fields changed: what was renamed, what was noted.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredWhat changed, and just enough of the item to place it.
idstring
  • format: uuid
optional
typestring optionalThe level.
collection_idstring
  • format: uuid
optionalThe collection the item belongs to.
updated_atstring
  • format: date-time
optionalWhen the item last changed - the instant of this update.
versioninteger optionalThe version the change produced.
change_setobject optionalOne member per field that moved, keyed by the field name the API uses.

de.hubtask.work.label.created.v1

A label was added to a collection's vocabulary.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredA snapshot of the label as it was created.
idstring
  • format: uuid
optional
collection_idstring
  • format: uuid
optionalThe collection whose vocabulary this label belongs to.
namestring optionalAt most 120 characters, on one line, unique in the collection without regard to case or accents.
color_tokenstring optionalA theme token rather than a colour value.
descriptionstring or null optional
deleted_atstring or null
  • format: date-time
optionalWhen the label was taken out of the vocabulary.
versioninteger optional

de.hubtask.work.label.deleted.v1

A label was taken out of a collection's vocabulary.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredA snapshot of the label as it was deleted.
idstring
  • format: uuid
optional
collection_idstring
  • format: uuid
optionalThe collection whose vocabulary this label belongs to.
namestring optionalAt most 120 characters, on one line, unique in the collection without regard to case or accents.
color_tokenstring optionalA theme token rather than a colour value.
descriptionstring or null optional
deleted_atstring or null
  • format: date-time
optionalWhen the label was taken out of the vocabulary.
versioninteger optional

de.hubtask.work.label.updated.v1

A label's own fields changed.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredA snapshot of the label as it now stands, and the change set beside it: the snapshot is what the label is, and the change set is what a field change trigger is written against.
idstring
  • format: uuid
optional
collection_idstring
  • format: uuid
optionalThe collection whose vocabulary this label belongs to.
namestring optionalAt most 120 characters, on one line, unique in the collection without regard to case or accents.
color_tokenstring optionalA theme token rather than a colour value.
descriptionstring or null optional
deleted_atstring or null
  • format: date-time
optionalWhen the label was taken out of the vocabulary.
versioninteger optional
change_setobject optionalOne entry per field that moved, each with the value on either side.

de.hubtask.work.recurrence.occurrence_created.v1

A series produced an entry: the occurrence a recurrence rule owed for a moment on its grid.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredWhich series, which template, which entry, and which moment of the rule's grid it is.
source_item_idstring
  • format: uuid
optionalThe entry the series sits on - the template the occurrence was copied from.
new_item_idstring
  • format: uuid
optionalThe entry that came out.
recurrence_rule_idstring
  • format: uuid
optionalThe series that produced it.
collection_idstring
  • format: uuid
optionalThe collection the occurrence belongs to, and the one an actor's permission to see it is judged against.
occurrence_atstring
  • format: date-time
optionalThe moment of the rule's grid this entry is, RFC 3339 in UTC.

de.hubtask.work.template.instantiated.v1

A template was stamped out: one call produced a tree of entries from a shape somebody had defined earlier.

NameTypeRequiredDescription
specversionstring required
idstring (uuid)
  • format: uuid
requiredUUIDv7.
sourcestring requiredThe installation and the bounded context that produced the event.
typestring required
subjectstring requiredWhat the event is about, so that a consumer can filter without parsing the payload.
timestring (date-time)
  • format: date-time
required
receivedatstring (date-time)
  • format: date-time
optionalWhen the server learned of the event.
datacontenttypestring required
tenantidstring (uuid)
  • format: uuid
required
actortypestring required
actoridstring (uuid)
  • format: uuid
optionalAbsent when the system itself acts.
onbehalfofstring (uuid)
  • format: uuid
optionalThe principal an automation rule or an agent runs as.
correlationidstring (uuid)
  • format: uuid
requiredEverything that came out of one original action carries the same value.
causationidstring (uuid)
  • format: uuid
optionalThe event that caused this one.
pushidstring (uuid)
  • format: uuid
optionalThe push a device brought the change in with, and absent for a change made online.
causationdepthinteger requiredDistance from the original action.
dataobject requiredWhich template, which root entry, where it landed, and how many entries came out.
template_idstring
  • format: uuid
optionalThe template that was stamped out.
root_item_idstring
  • format: uuid
optionalThe entry at the top of the tree that came out, and the event's subject.
collection_idstring
  • format: uuid
optionalThe collection the tree landed in, and the one an actor's permission to see it is judged against.
createdinteger optionalHow many entries came out, the root included.