Docs
IntegrationsReference

Data Formats

Data format conventions — naming, dates, numbers, Title Case, and field constraints.

Use these conventions to reduce validation errors and keep data interoperable.

Metadata attribute names

Use Title Case for metadata attribute names (e.g. Vehicle License Plate, Gross Weight, Issue Date). Do not use kebab-case or lowercase-concatenated names in event metadata.

Date and time

  • Use ISO 8601 UTC timestamps (YYYY-MM-DDTHH:mm:ss.sssZ) for date-time fields.
  • For date-only fields, use ISO 8601 date format and, when required by the API, include a format attribute (e.g. DATE).
  • Preserve source chronology across event submissions.

Identifiers

  • Keep IDs stable and deterministic across retries.
  • Use deduplicationId for idempotent retry behavior.

Naming conventions

  • Use consistent attribute names and avoid synonymous duplicates.
  • Prefer structured metadata over free-form string blobs.

Numeric values and units

  • Send numeric fields as numbers, not localized strings.
  • When the API requires a unit or scale, use the format attribute with the appropriate value (e.g. KILOGRAM, LITER, CUBIC_METER for mass/volume).
  • Keep unit choice consistent within a document lifecycle.

Sensitive data

For attributes that contain sensitive or personal data (e.g. license plates, driver identifiers):

  • Send the full value in your payload — do not pre-mask or redact.
  • Set sensible: true in the metadata so the platform can apply masking on public surfaces.
  • See Privacy & Masking for visibility controls.

Related references:

On this page