Skip to main content

Suggest event-stream field mappings

Derive deterministic candidate identity and event-field mappings from a sample payload or supplied field list. This helper does not save a definition.

POST/api/table-event-streams/suggest-mappings
HTTP referenceScope tables:readUpdated September 27, 2026

This page documents the canonical HTTP contract for this endpoint.

Developer API keys need the listed scope. A valid authenticated user session may also call this route.

Suggestions are heuristic and may be empty when no sample fields are available. Review and validate suggested table column keys before saving a definition. The response shape is abridged and illustrative.

Body parameters

  • sample_payload · optional

    any

    Optional representative event payload.

  • fields · optional

    array<object>

    Optional fields with required key and optional label, data_type, sample_values, and schema.

Errors

StatusMeaning
401Authentication is missing or invalid.
403The credential is invalid or lacks the required scope, or the caller cannot access the resource.
422A supplied field descriptor is invalid.

Docs