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.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | rule_run/<id> - the run, which is what a consumer looks the rest up by. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | |
run_id | string
| optional | The run. |
rule_id | string
| optional | The rule the run belongs to. |
event_id | string or null
| optional | The event that started the run, when one did. |
causation_depth | integer | optional | How far this run is from the act a person performed. |
status | string | optional | ABORTED_LOOP is the loop protection: the run was at the depth limit and did nothing. |
error_code | string | optional | The message code the run ended on. |
rule_disabled | boolean | optional | True 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.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | rule_run/<id> - the run, which is what a consumer looks the rest up by. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | |
run_id | string
| optional | The run. |
rule_id | string
| optional | The rule the run belongs to. |
event_id | string or null
| optional | The event that started the run, when one did. |
causation_depth | integer | optional | How far this run is from the act a person performed. |
status | string | optional | SUCCEEDED acted, SKIPPED had a condition answer false, THROTTLED was held back by the rule's own bound. |
actions_succeeded | integer | optional | How many actions ran and did what they say. |
actions_failed | integer | optional | How many ran and refused. |
de.hubtask.automation.rule_run.started.v1
An automation rule began a run.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | rule_run/<id> - the run, which is what a consumer looks the rest up by. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | |
run_id | string
| optional | The run. |
rule_id | string
| optional | The rule the run belongs to. |
event_id | string or null
| optional | The event that started the run, when one did. |
causation_depth | integer | optional | How 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.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | jumble_entry/<id> - the entry that was converted. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | |
id | string
| optional | The entry. |
channel | string | optional | How it originally arrived. |
target_item_id | string
| optional | The item the conversion produced - the other half of the provenance pair. |
collection_id | string
| optional | Where the item was created. |
de.hubtask.jumble.entry.received.v1
An entry arrived in the jumble.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | jumble_entry/<id> - the entry, which is what a consumer looks the rest up by. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | |
id | string
| optional | The entry. |
channel | string | optional | How it arrived. |
attachment_count | integer | optional | How many media objects it carries. |
received_at | string
| optional |
de.hubtask.work.attachment.added.v1
An entry now carries a file.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | The 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_id | string
| optional | |
collection_id | string
| optional | The collection the entry belongs to, which is where the permission to see the attachment is resolved from. |
media_id | string
| optional | The media object that was attached. |
de.hubtask.work.attachment.removed.v1
An entry no longer carries a file.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | The reference rather than a snapshot of the entry, exactly as the addition carries it. |
item_id | string
| optional | |
collection_id | string
| optional | The collection the entry belongs to, which is where the permission to see the attachment is resolved from. |
media_id | string
| optional | The media object that was detached. |
de.hubtask.work.bucket.created.v1
A column was added to a collection's board.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | A snapshot of the bucket as it was created. |
id | string
| optional | |
collection_id | string
| optional | The collection whose board this column belongs to. |
name | string | optional | At most 120 characters, on one line, unique in the collection without regard to case or accents. |
order_key | string | optional | The rank on the board: a fractional index, not a number. |
wip_limit | integer or null | optional | How many entries the people using this board agreed to have in the column at once, or null for no limit. |
is_done_bucket | boolean | optional | Whether this column means finished. |
color_token | string or null | optional | A theme token rather than a colour value, so that a client can render it in its own palette. |
deleted_at | string or null
| optional | When the column was taken off the board. |
version | integer | optional |
de.hubtask.work.bucket.deleted.v1
A column was taken off a collection's board, and its entries moved.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | A snapshot of the column as it was deleted, and what became of the entries that were in it. |
id | string
| optional | |
collection_id | string
| optional | The collection whose board this column belongs to. |
name | string | optional | At most 120 characters, on one line, unique in the collection without regard to case or accents. |
order_key | string | optional | The rank on the board: a fractional index, not a number. |
wip_limit | integer or null | optional | How many entries the people using this board agreed to have in the column at once, or null for no limit. |
is_done_bucket | boolean | optional | Whether this column means finished. |
color_token | string or null | optional | A theme token rather than a colour value, so that a client can render it in its own palette. |
deleted_at | string or null
| optional | When the column was taken off the board. |
version | integer | optional | |
target_bucket_id | string or null
| optional | The column the entries moved to - the leftmost remaining one. |
moved_items | integer | optional | How many entries were moved. |
de.hubtask.work.bucket.reordered.v1
A column moved along its board.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | A 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. |
id | string
| optional | |
collection_id | string
| optional | The collection whose board this column belongs to. |
name | string | optional | At most 120 characters, on one line, unique in the collection without regard to case or accents. |
order_key | string | optional | The rank on the board: a fractional index, not a number. |
wip_limit | integer or null | optional | How many entries the people using this board agreed to have in the column at once, or null for no limit. |
is_done_bucket | boolean | optional | Whether this column means finished. |
color_token | string or null | optional | A theme token rather than a colour value, so that a client can render it in its own palette. |
deleted_at | string or null
| optional | When the column was taken off the board. |
version | integer | optional | |
change_set | object | optional | One entry per field that moved, each with the value on either side. |
de.hubtask.work.bucket.updated.v1
A column's own fields changed.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | A 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. |
id | string
| optional | |
collection_id | string
| optional | The collection whose board this column belongs to. |
name | string | optional | At most 120 characters, on one line, unique in the collection without regard to case or accents. |
order_key | string | optional | The rank on the board: a fractional index, not a number. |
wip_limit | integer or null | optional | How many entries the people using this board agreed to have in the column at once, or null for no limit. |
is_done_bucket | boolean | optional | Whether this column means finished. |
color_token | string or null | optional | A theme token rather than a colour value, so that a client can render it in its own palette. |
deleted_at | string or null
| optional | When the column was taken off the board. |
version | integer | optional | |
change_set | object | optional | One 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.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | The 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. |
id | string
| optional | |
item_id | string
| optional | The entry the discussion belongs to - what a rule reads the rest from. |
collection_id | string
| optional | |
author_id | string
| optional | Who 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_id | string or null
| optional | The comment this one replies to, null for a top-level comment. |
body | string or null | optional | The text, null exactly when deleted_at is set: a tombstone keeps the comment's identity and loses its words. |
created_at | string
| optional | |
edited_at | string or null
| optional | |
deleted_at | string or null
| optional | |
version | integer | 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.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | The 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. |
id | string
| optional | |
item_id | string
| optional | The entry the discussion belongs to - what a rule reads the rest from. |
collection_id | string
| optional | |
author_id | string
| optional | Who 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_id | string or null
| optional | The comment this one replies to, null for a top-level comment. |
body | string or null | optional | The text, null exactly when deleted_at is set: a tombstone keeps the comment's identity and loses its words. |
created_at | string
| optional | |
edited_at | string or null
| optional | |
deleted_at | string or null
| optional | |
version | integer | optional |
de.hubtask.work.comment.updated.v1
A comment's text was rewritten.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | The 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. |
id | string
| optional | |
item_id | string
| optional | The entry the discussion belongs to - what a rule reads the rest from. |
collection_id | string
| optional | |
author_id | string
| optional | Who 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_id | string or null
| optional | The comment this one replies to, null for a top-level comment. |
body | string or null | optional | The text, null exactly when deleted_at is set: a tombstone keeps the comment's identity and loses its words. |
created_at | string
| optional | |
edited_at | string or null
| optional | |
deleted_at | string or null
| optional | |
version | integer | optional |
de.hubtask.work.container.archived.v1
A container is read-only, and everything under it with it.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | A snapshot of the container as it now stands, archived_at carrying the moment. |
id | string
| optional | |
type | string | optional | |
parent_id | string or null
| optional | The hub a collection sits in; null for a hub. |
name | string | optional | |
description | string | optional | |
icon | string | optional | |
color_token | string | optional | A theme token rather than a colour value, so that a client can render it in its own palette. |
order_key | string | optional | The rank among the siblings: a fractional index, not a number. |
completion_policy | string | optional | Whether a child's completion propagates upwards. |
auto_assign | object or null | optional | The collection's automatic assignment policy, null for none. |
archived_at | string or null
| optional | When this container was archived in its own right. |
effective_archived | boolean | optional | Whether the container is read-only: archived itself, or sitting in an archived hub. |
created_at | string
| optional | |
created_by | string
| optional | |
updated_at | string
| optional | |
version | integer | optional | |
private | boolean | optional | Whether 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.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | A snapshot of the container as it was created. |
id | string
| optional | |
type | string | optional | |
parent_id | string or null
| optional | The hub a collection sits in; null for a hub. |
name | string | optional | |
description | string | optional | |
icon | string | optional | |
color_token | string | optional | A theme token rather than a colour value, so that a client can render it in its own palette. |
order_key | string | optional | The rank among the siblings: a fractional index, not a number. |
completion_policy | string | optional | Whether a child's completion propagates upwards. |
auto_assign | object or null | optional | The collection's automatic assignment policy, null for none. |
archived_at | string or null
| optional | When this container was archived in its own right. |
effective_archived | boolean | optional | Whether the container is read-only: archived itself, or sitting in an archived hub. |
created_at | string
| optional | |
created_by | string
| optional | |
updated_at | string
| optional | |
version | integer | optional | |
private | boolean | optional | Whether 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.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | A snapshot of the container as it now stands, with the deletion's own fields and how much went with it. |
id | string
| optional | |
type | string | optional | |
parent_id | string or null
| optional | The hub a collection sits in; null for a hub. |
name | string | optional | |
description | string | optional | |
icon | string | optional | |
color_token | string | optional | A theme token rather than a colour value, so that a client can render it in its own palette. |
order_key | string | optional | The rank among the siblings: a fractional index, not a number. |
completion_policy | string | optional | Whether a child's completion propagates upwards. |
auto_assign | object or null | optional | The collection's automatic assignment policy, null for none. |
archived_at | string or null
| optional | When this container was archived in its own right. |
effective_archived | boolean | optional | Whether the container is read-only: archived itself, or sitting in an archived hub. |
created_at | string
| optional | |
created_by | string
| optional | |
updated_at | string
| optional | |
private | boolean | optional | Whether the hub is private: reached only by people holding a role on it or below it. |
version | integer | optional | |
deleted_at | string or null
| optional | When the entry went into the trash. |
trash_batch_id | string or null
| optional | The deletion every row of one act shares. |
collections | integer | optional | How many collections the act took with it. |
items | integer | optional | How 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.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | A snapshot of the collection where it now sits, with the hub it came from beside it. |
id | string
| optional | |
type | string | optional | |
parent_id | string or null
| optional | The hub a collection sits in; null for a hub. |
name | string | optional | |
description | string | optional | |
icon | string | optional | |
color_token | string | optional | A theme token rather than a colour value, so that a client can render it in its own palette. |
order_key | string | optional | The rank among the siblings: a fractional index, not a number. |
completion_policy | string | optional | Whether a child's completion propagates upwards. |
auto_assign | object or null | optional | The collection's automatic assignment policy, null for none. |
archived_at | string or null
| optional | When this container was archived in its own right. |
effective_archived | boolean | optional | Whether the container is read-only: archived itself, or sitting in an archived hub. |
created_at | string
| optional | |
created_by | string
| optional | |
updated_at | string
| optional | |
private | boolean | optional | Whether the hub is private: reached only by people holding a role on it or below it. |
version | integer | optional | |
from_parent_id | string or null
| optional | The 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.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | A snapshot of the collection as it now stands, and the change set beside it. |
id | string
| optional | |
type | string | optional | |
parent_id | string or null
| optional | The hub a collection sits in; null for a hub. |
name | string | optional | |
description | string | optional | |
icon | string | optional | |
color_token | string | optional | A theme token rather than a colour value, so that a client can render it in its own palette. |
order_key | string | optional | The rank among the siblings: a fractional index, not a number. |
completion_policy | string | optional | Whether a child's completion propagates upwards. |
auto_assign | object or null | optional | The collection's automatic assignment policy, null for none. |
archived_at | string or null
| optional | When this container was archived in its own right. |
effective_archived | boolean | optional | Whether the container is read-only: archived itself, or sitting in an archived hub. |
created_at | string
| optional | |
created_by | string
| optional | |
updated_at | string
| optional | |
private | boolean | optional | Whether the hub is private: reached only by people holding a role on it or below it. |
version | integer | optional | |
change_set | object | optional | The 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.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | A snapshot of the container as it now stands, and the change set beside it. |
id | string
| optional | |
type | string | optional | |
parent_id | string or null
| optional | The hub a collection sits in; null for a hub. |
name | string | optional | |
description | string | optional | |
icon | string | optional | |
color_token | string | optional | A theme token rather than a colour value, so that a client can render it in its own palette. |
order_key | string | optional | The rank among the siblings: a fractional index, not a number. |
completion_policy | string | optional | Whether a child's completion propagates upwards. |
auto_assign | object or null | optional | The collection's automatic assignment policy, null for none. |
archived_at | string or null
| optional | When this container was archived in its own right. |
effective_archived | boolean | optional | Whether the container is read-only: archived itself, or sitting in an archived hub. |
created_at | string
| optional | |
created_by | string
| optional | |
updated_at | string
| optional | |
private | boolean | optional | Whether the hub is private: reached only by people holding a role on it or below it. |
version | integer | optional | |
change_set | object | optional | The fields that moved, each with the value on both sides. |
de.hubtask.work.container.restored.v1
A container's deletion has been reversed, whole.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | A snapshot of the container as it now stands, deleted_at null again, with how much came back. |
id | string
| optional | |
type | string | optional | |
parent_id | string or null
| optional | The hub a collection sits in; null for a hub. |
name | string | optional | |
description | string | optional | |
icon | string | optional | |
color_token | string | optional | A theme token rather than a colour value, so that a client can render it in its own palette. |
order_key | string | optional | The rank among the siblings: a fractional index, not a number. |
completion_policy | string | optional | Whether a child's completion propagates upwards. |
auto_assign | object or null | optional | The collection's automatic assignment policy, null for none. |
archived_at | string or null
| optional | When this container was archived in its own right. |
effective_archived | boolean | optional | Whether the container is read-only: archived itself, or sitting in an archived hub. |
created_at | string
| optional | |
created_by | string
| optional | |
updated_at | string
| optional | |
private | boolean | optional | Whether the hub is private: reached only by people holding a role on it or below it. |
version | integer | optional | |
deleted_at | string or null
| optional | When the entry went into the trash. |
trash_batch_id | string or null
| optional | The deletion every row of one act shares. |
collections | integer | optional | How many collections the act took with it. |
items | integer | optional | How many entries the act took with it, at every level. |
de.hubtask.work.container.unarchived.v1
A container is writable again.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | A snapshot of the container as it now stands, archived_at back to null. |
id | string
| optional | |
type | string | optional | |
parent_id | string or null
| optional | The hub a collection sits in; null for a hub. |
name | string | optional | |
description | string | optional | |
icon | string | optional | |
color_token | string | optional | A theme token rather than a colour value, so that a client can render it in its own palette. |
order_key | string | optional | The rank among the siblings: a fractional index, not a number. |
completion_policy | string | optional | Whether a child's completion propagates upwards. |
auto_assign | object or null | optional | The collection's automatic assignment policy, null for none. |
archived_at | string or null
| optional | When this container was archived in its own right. |
effective_archived | boolean | optional | Whether the container is read-only: archived itself, or sitting in an archived hub. |
created_at | string
| optional | |
created_by | string
| optional | |
updated_at | string
| optional | |
private | boolean | optional | Whether the hub is private: reached only by people holding a role on it or below it. |
version | integer | optional |
de.hubtask.work.item.archived.v1
An entry is kept and read-only.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | A snapshot of the entry as it now stands, archived_at carrying the moment. |
id | string
| optional | |
type | string | optional | The level. |
collection_id | string
| optional | The collection the item belongs to. |
parent_id | string or null
| optional | The item above; null for one that sits directly under the collection. |
path | string | optional | The materialised path, /<id>/<id>/…/, including the item itself and closed by a separator. |
depth | integer | optional | The level below the collection, counting from 1. |
title | string | optional | |
notes | string | optional | Markdown, unrendered by the server. |
completion | object | optional | The done/open state. |
order_key | string | optional | The rank among the siblings: a fractional index, not a number. |
created_at | string
| optional | |
created_by | string
| optional | |
version | integer | optional | |
updated_at | string
| optional | When the item last changed - the instant of this completion change. |
archived_at | string or null
| optional | When the entry was archived: kept, and read-only. |
deleted_at | string or null
| optional | When the entry went into the trash. |
trash_batch_id | string or null
| optional | The deletion every row of one act shares. |
de.hubtask.work.item.assigned.v1
An entry is on somebody.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | The 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_id | string
| optional | |
collection_id | string
| optional | The collection the entry belongs to, and the one an actor's permission to see it is judged against. |
assignee_id | string
| optional | The account the entry is now assigned to. |
strategy | string | optional | The 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.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | A 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. |
id | string
| optional | |
type | string | optional | The level. |
collection_id | string
| optional | The collection the item belongs to. |
parent_id | string or null
| optional | The item above; null for one that sits directly under the collection. |
path | string | optional | The materialised path, /<id>/<id>/…/, including the item itself and closed by a separator. |
depth | integer | optional | The level below the collection, counting from 1. |
title | string | optional | |
notes | string | optional | Markdown, unrendered by the server. |
completion | object | optional | The done state. |
order_key | string | optional | The rank among the siblings: a fractional index, not a number. |
created_at | string
| optional | |
created_by | string
| optional | |
version | integer | optional | |
updated_at | string
| optional | When 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.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | A 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. |
id | string
| optional | |
type | string | optional | The level. |
collection_id | string
| optional | The collection the item belongs to. |
parent_id | string or null
| optional | The item above; null for one that sits directly under the collection. |
path | string | optional | The materialised path, /<id>/<id>/…/, including the item itself and closed by a separator. |
depth | integer | optional | The level below the collection, counting from 1. |
title | string | optional | |
notes | string | optional | Markdown, unrendered by the server. |
completion | object | optional | The done/open state. |
order_key | string | optional | The rank among the siblings: a fractional index, not a number. |
created_at | string
| optional | |
created_by | string
| optional | |
version | integer | optional | |
updated_at | string
| optional | When the item last changed. |
de.hubtask.work.item.due_changed.v1
An entry's due date moved: set, moved to another moment, or cleared.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | Both 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_id | string
| optional | |
collection_id | string
| optional | The collection the entry belongs to, and the one an actor's permission to see it is judged against. |
old_due_at | string
| optional | RFC 3339 in UTC. |
new_due_at | string
| optional | RFC 3339 in UTC. |
due_date_only | boolean | optional | True for an all-day due date: new_due_at is read as a date in time_zone, never as an instant. |
time_zone | string | optional | The 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.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | What is due and how soon. |
item_id | string
| optional | |
collection_id | string
| optional | The collection the entry belongs to, and the one an actor's permission to see it is judged against. |
due_at | string
| optional | The due date this announcement is about, RFC 3339 in UTC. |
due_date_only | boolean | optional | True for an all-day due date: due_at is read as a date in time_zone, never as an instant. |
time_zone | string | optional | The IANA zone the due date is local to, present when one was stored. |
threshold_spec | string | optional | The 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.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | The 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_id | string
| optional | |
collection_id | string
| optional | The collection the entry belongs to, and the one whose vocabulary the label comes from. |
label_id | string
| optional | The label that was added or removed. |
de.hubtask.work.item.label_removed.v1
An entry no longer carries a label.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | The 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_id | string
| optional | |
collection_id | string
| optional | The collection the entry belongs to, and the one whose vocabulary the label comes from. |
label_id | string
| optional | The label that was added or removed. |
de.hubtask.work.item.member_added.v1
An account is on an entry's member list.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | The 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_id | string
| optional | |
collection_id | string
| optional | The collection the entry belongs to, and the one an actor's permission to see it is judged against. |
account_id | string
| optional | The account that was added or removed. |
de.hubtask.work.item.member_removed.v1
An account is off an entry's member list.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | The 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_id | string
| optional | |
collection_id | string
| optional | The collection the entry belongs to, and the one an actor's permission to see it is judged against. |
account_id | string
| optional | The 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.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | The item as it now stands, in the field names of the API (schema WorkItem), plus where it came from. |
id | string
| optional | |
type | string | optional | The level. |
collection_id | string
| optional | The collection the item belongs to. |
parent_id | string or null
| optional | The item above; null for one that sits directly under the collection. |
path | string | optional | The materialised path, /<id>/<id>/…/, including the item itself and closed by a separator. |
depth | integer | optional | The level below the collection, counting from 1. |
title | string | optional | |
notes | string | optional | Markdown, unrendered by the server. |
completion | object | optional | The done/open state. |
order_key | string | optional | The rank among the siblings: a fractional index, not a number. |
created_at | string
| optional | |
created_by | string
| optional | |
version | integer | optional | |
updated_at | string
| optional | When the item last changed - the instant of this move. |
from_parent_id | string or null
| optional | The item it sat under before, null if it sat directly in a collection. |
to_parent_id | string or null
| optional | The item it sits under now, null for the top level of a collection. |
from_path | string | optional | The materialised path before the move. |
from_collection_id | string or null
| optional | The collection it was in before, set only when the move crossed collections. |
from_bucket_id | string or null
| optional | The column of the board it sat in before, null if it was on none. |
to_bucket_id | string or null
| optional | The 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.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | What was due and when. |
item_id | string
| optional | |
collection_id | string
| optional | The collection the entry belongs to, and the one an actor's permission to see it is judged against. |
due_at | string
| optional | The due date this announcement is about, RFC 3339 in UTC. |
due_date_only | boolean | optional | True for an all-day due date: due_at is read as a date in time_zone, never as an instant. |
time_zone | string | optional | The IANA zone the due date is local to, present when one was stored. |
threshold_spec | string | optional | PT0S: the threshold of this announcement is the moment itself. |
de.hubtask.work.item.purged.v1
An entry is gone for good.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | What is left to say about an entry that no longer exists. |
id | string
| optional | |
type | string | optional | |
collection_id | string
| optional | |
path | string | optional | The materialised path the entry had. |
purged_at | string
| optional | |
reason | string | optional | Whether 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.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | A 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. |
id | string
| optional | |
type | string | optional | The level. |
collection_id | string
| optional | The collection the item belongs to. |
parent_id | string or null
| optional | The item above; null for one that sits directly under the collection. |
path | string | optional | The materialised path, /<id>/<id>/…/, including the item itself and closed by a separator. |
depth | integer | optional | The level below the collection, counting from 1. |
title | string | optional | |
notes | string | optional | Markdown, unrendered by the server. |
completion | object | optional | The done state. |
order_key | string | optional | The rank among the siblings: a fractional index, not a number. |
created_at | string
| optional | |
created_by | string
| optional | |
version | integer | optional | |
updated_at | string
| optional | When the item last changed - the instant of this completion change. |
de.hubtask.work.item.restored.v1
A deletion has been reversed, whole.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | A snapshot of the entry as it now stands, deleted_at null again, with how much came back. |
id | string
| optional | |
type | string | optional | The level. |
collection_id | string
| optional | The collection the item belongs to. |
parent_id | string or null
| optional | The item above; null for one that sits directly under the collection. |
path | string | optional | The materialised path, /<id>/<id>/…/, including the item itself and closed by a separator. |
depth | integer | optional | The level below the collection, counting from 1. |
title | string | optional | |
notes | string | optional | Markdown, unrendered by the server. |
completion | object | optional | The done/open state. |
order_key | string | optional | The rank among the siblings: a fractional index, not a number. |
created_at | string
| optional | |
created_by | string
| optional | |
version | integer | optional | |
updated_at | string
| optional | When the item last changed - the instant of this completion change. |
archived_at | string or null
| optional | When the entry was archived: kept, and read-only. |
deleted_at | string or null
| optional | When the entry went into the trash. |
trash_batch_id | string or null
| optional | The deletion every row of one act shares. |
subtree_size | integer | optional | How 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.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | A 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. |
id | string
| optional | |
type | string | optional | The level. |
collection_id | string
| optional | The collection the item belongs to. |
parent_id | string or null
| optional | The item above; null for one that sits directly under the collection. |
path | string | optional | The materialised path, /<id>/<id>/…/, including the item itself and closed by a separator. |
depth | integer | optional | The level below the collection, counting from 1. |
title | string | optional | |
notes | string | optional | Markdown, unrendered by the server. |
completion | object | optional | The done/open state. |
order_key | string | optional | The rank among the siblings: a fractional index, not a number. |
created_at | string
| optional | |
created_by | string
| optional | |
version | integer | optional | |
updated_at | string
| optional | When the item last changed - the instant of this completion change. |
archived_at | string or null
| optional | When the entry was archived: kept, and read-only. |
deleted_at | string or null
| optional | When the entry went into the trash. |
trash_batch_id | string or null
| optional | The deletion every row of one act shares. |
subtree_size | integer | optional | How many rows the act touched, this entry included. |
de.hubtask.work.item.unarchived.v1
An archived entry is writable again.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | A snapshot of the entry as it now stands, archived_at null again. |
id | string
| optional | |
type | string | optional | The level. |
collection_id | string
| optional | The collection the item belongs to. |
parent_id | string or null
| optional | The item above; null for one that sits directly under the collection. |
path | string | optional | The materialised path, /<id>/<id>/…/, including the item itself and closed by a separator. |
depth | integer | optional | The level below the collection, counting from 1. |
title | string | optional | |
notes | string | optional | Markdown, unrendered by the server. |
completion | object | optional | The done/open state. |
order_key | string | optional | The rank among the siblings: a fractional index, not a number. |
created_at | string
| optional | |
created_by | string
| optional | |
version | integer | optional | |
updated_at | string
| optional | When the item last changed - the instant of this completion change. |
archived_at | string or null
| optional | When the entry was archived: kept, and read-only. |
deleted_at | string or null
| optional | When the entry went into the trash. |
trash_batch_id | string or null
| optional | The deletion every row of one act shares. |
de.hubtask.work.item.unassigned.v1
An entry is on nobody, and this is who it was.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | The 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_id | string
| optional | |
collection_id | string
| optional | The collection the entry belongs to, and the one an actor's permission to see it is judged against. |
assignee_id | string
| optional | The 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.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | What changed, and just enough of the item to place it. |
id | string
| optional | |
type | string | optional | The level. |
collection_id | string
| optional | The collection the item belongs to. |
updated_at | string
| optional | When the item last changed - the instant of this update. |
version | integer | optional | The version the change produced. |
change_set | object | optional | One 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.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | A snapshot of the label as it was created. |
id | string
| optional | |
collection_id | string
| optional | The collection whose vocabulary this label belongs to. |
name | string | optional | At most 120 characters, on one line, unique in the collection without regard to case or accents. |
color_token | string | optional | A theme token rather than a colour value. |
description | string or null | optional | |
deleted_at | string or null
| optional | When the label was taken out of the vocabulary. |
version | integer | optional |
de.hubtask.work.label.deleted.v1
A label was taken out of a collection's vocabulary.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | A snapshot of the label as it was deleted. |
id | string
| optional | |
collection_id | string
| optional | The collection whose vocabulary this label belongs to. |
name | string | optional | At most 120 characters, on one line, unique in the collection without regard to case or accents. |
color_token | string | optional | A theme token rather than a colour value. |
description | string or null | optional | |
deleted_at | string or null
| optional | When the label was taken out of the vocabulary. |
version | integer | optional |
de.hubtask.work.label.updated.v1
A label's own fields changed.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | A 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. |
id | string
| optional | |
collection_id | string
| optional | The collection whose vocabulary this label belongs to. |
name | string | optional | At most 120 characters, on one line, unique in the collection without regard to case or accents. |
color_token | string | optional | A theme token rather than a colour value. |
description | string or null | optional | |
deleted_at | string or null
| optional | When the label was taken out of the vocabulary. |
version | integer | optional | |
change_set | object | optional | One 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.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | Which series, which template, which entry, and which moment of the rule's grid it is. |
source_item_id | string
| optional | The entry the series sits on - the template the occurrence was copied from. |
new_item_id | string
| optional | The entry that came out. |
recurrence_rule_id | string
| optional | The series that produced it. |
collection_id | string
| optional | The collection the occurrence belongs to, and the one an actor's permission to see it is judged against. |
occurrence_at | string
| optional | The 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.
| Name | Type | Required | Description |
|---|---|---|---|
specversion | string | required | |
id | string (uuid)
| required | UUIDv7. |
source | string | required | The installation and the bounded context that produced the event. |
type | string | required | |
subject | string | required | What the event is about, so that a consumer can filter without parsing the payload. |
time | string (date-time)
| required | |
receivedat | string (date-time)
| optional | When the server learned of the event. |
datacontenttype | string | required | |
tenantid | string (uuid)
| required | |
actortype | string | required | |
actorid | string (uuid)
| optional | Absent when the system itself acts. |
onbehalfof | string (uuid)
| optional | The principal an automation rule or an agent runs as. |
correlationid | string (uuid)
| required | Everything that came out of one original action carries the same value. |
causationid | string (uuid)
| optional | The event that caused this one. |
pushid | string (uuid)
| optional | The push a device brought the change in with, and absent for a change made online. |
causationdepth | integer | required | Distance from the original action. |
data | object | required | Which template, which root entry, where it landed, and how many entries came out. |
template_id | string
| optional | The template that was stamped out. |
root_item_id | string
| optional | The entry at the top of the tree that came out, and the event's subject. |
collection_id | string
| optional | The collection the tree landed in, and the one an actor's permission to see it is judged against. |
created | integer | optional | How many entries came out, the root included. |