(Raw) message fields
The (raw) message fields contain the metadata used for identifying its source and processing attributes. These fields are the same for both the inbound and outbound channels.
Property | Description | ||
|---|---|---|---|
messageID | The identifier that uniquely identifies the message. If the same message is sent twice, which can happen if a network problem occurred, Planon will use this identifier to detect the duplicates. The identifier must be a UUID. | ||
From | A unique identification of the message’s sender, unique in the context of the Planon application.* | ||
systemType | A unique identification of the type of the system. The systemType value is used to match the transformer and processor to the message.*
| ||
messageType | An identification of the type of the message. The messageType must be unique in the context of the systemType. The messageType value is also used to match the transformer and processor to the message.* | ||
messageBody | Contains the actual message content. The only requirement is that it is a valid JSON value and does not exceed 32,000 characters. This value will be passed to the processor. | ||
transmissionStrategy | Lists the strategy that is used (push/pull) to deliver the message to the external system. | ||
Attributes | Contains the transformed message in the form of key value pairs. | ||
Remark | Contains remarks registered when processing the message. Contains details when a failure occurs. | ||
Additional info | Additional info that cannot be in the message body and that is needed to send the message. This could, for example, be mail settings or endpoint information. Event connector is designed as a light-weight messaging system. Therefore, the maximum size of the Additional info is 64Kb. |
 | *Do not add leading or trailing spaces, these will be removed. |