Message headers
- Last UpdatedAug 19, 2026
- 1 minute read
The following headers are supported in message specification. Headers may be added or removed over time. Backwards compatibility is achievable through the omfversion header.
|
Name |
Value |
|---|---|
|
messagetype |
Identifies the OMF 2.0 message category, such as schema or instance, and determines how the destination interprets the message body. See Message types for additional information. |
|
messageformat |
The format of the OMF message payload. This value tells the endpoint how to parse the message body and must match the payload format. Currently limited to json. |
|
omfversion |
Specifies the version of the Open Message Format used in the message. The version for the current specification is 2.0. |
|
action |
Specifies the operation to perform on the OMF message payload. This optional value tells the endpoint whether the message creates, updates, patches or deletes the referenced OMF object or data. If omitted, create is assumed. |
|
compression |
(Optional) The compression algorithm used to compress the message body. Currently limited to gzip. If this is not specified, the message body is assumed to be uncompressed. |