Skip to main content
The Field Model V1 Events API allows you to manage events (claims and incidents) with company-configured dynamic fields. Unlike the standard Events API where fields are fixed, Field Model V1 companies define their own fields per entity type — the set of available fields is configured per company. Key Concepts:
  • Events have two types: claim and incident. Permissions are type-specific.
  • Fields are dynamically defined per company. Use the Configuration endpoint to discover available fields and their types.
  • The request body for create and update is a flat JSON object where keys are field referenceIds (e.g., lossDescription, lossDate).
  • Responses include a fieldModelV1Data object containing all field values (including base fields like eventType and eventCoverageType).
  • Updates are full replacements — include all fields you want the event to have, not just the changed ones.

Base Fields

These fields are handled specially by the API:

Configuration

Call GET /v1/events/configuration to get a JSON Schema of available fields for your company. The schema includes:
  • Field types: string, number, boolean, object
  • Option Set fields: include an enum array of valid values
  • Required fields: listed in the required array

Field Types


API Endpoints

See also: Event Financials for reserves and expected totals endpoints.

Permissions

Permissions are type-specific for create, update, and delete operations.

Example Create Request

Example Response

The top-level policyId and fieldModelV1Data.eventPolicy always reflect the same value — policyId is a convenience alias preserved for backwards compatibility.