data_entity.* events
The lifecycle of a project's data dictionary: an entity created, changed, moved along its review, its fields replaced and the entity deleted.
The lifecycle of a project's data dictionary: an entity created, changed, moved along its review, its fields replaced and the entity deleted. Requirements, business rules, API contracts and database designs are read against the dictionary, so a mirror of the planning record, a schema generator or a data-protection register subscribes to this family to follow it.
Every event in the family is scoped to the project, so project_id in the envelope is always set and an endpoint confined to one project receives only that project's events. The payloads are thin on purpose: the ids, the name and what the transition itself carries, never a snapshot of the entity or its fields. Read the data entities endpoint for the record.
Background
Required ability
Tokens subscribing to data_entity.* events need data-entity:view at mint time.
Events
data_entity.createdAn entity is created.data_entity.updatedAn entity's fields change.data_entity.status_changedAn entity moves along its review.data_entity.fields_changedThe entity's fields are replaced.data_entity.deletedAn entity is deleted.data_entity.restoredAn earlier version of a entity is put back.How is this guide?
Last updated on