Message structure
Last updated
Was this helpful?
Last updated
Was this helpful?
Messages are sent as a JSON string. The fields in the JSON object vary depending on the type of message, but they always include:
audit information (createdBy, createdDate, lastUpdatedBy, lastUpdatedDate, etc.)
Entity messages, no matter the char type or action, will contain an entity field with details of the entity that the action was performed on. For instance:
Relationship messages will have fields for both the parentEntity
and childEntity
such as:
Component entity messages are entity messages that are performed specifically on component records. The component char types can be identified in . A component char type is a record that cannot exist on it's own. It must exist as a child of another record. Therefore, there is an additional field on component entity messages called rootEntity
. The root entity is the parent of the component record, and contains the parents char type ID and record ID:
Examples of each of the messages can be found .