- Events have two types:
claimandincident. 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
fieldModelV1Dataobject containing all field values (including base fields likeeventTypeandeventCoverageType). - 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
CallGET /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
enumarray of valid values - Required fields: listed in the
requiredarray
Field Types
API Endpoints
- Get Configuration - JSON Schema of available fields
- Create Event - Create a new event
- List Events - Paginated list with filtering and sorting
- Get Event - Retrieve a single event by ID
- Update Event - Full replacement update (PUT)
- Delete Event - Delete with type-based permission
Permissions
Permissions are type-specific for create, update, and delete operations.Example Create Request
Example Response
policyId and fieldModelV1Data.eventPolicy always reflect the same value — policyId is a convenience alias preserved for backwards compatibility.