Skip to content

POLICY_EVENT_RECORD

Record a policy event in the policy timeline.

Submit this event using Firing an Event. Product configuration and enabled actions determine the workflow behavior. Use identifiers and snapshots from the same environment.

Request payload#

HTTPPOST
POST https://api.{ENV}.dais.com/ioi/v3/event/fire
cURL
curl --location --request POST 'https://api.{ENV}.dais.com/ioi/v3/event/fire' \
--header 'Authorization: Basic <Base64-encoded API key and secret>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "lineId": "<UUID of the product ID>",
  "type": "POLICY_EVENT_RECORD",
  "payload": {
    "policyId": "<UUID of the policy ID>",
    "type": "NOTE",
    "label": "<Label>",
    "description": "<Description>",
    "effectiveDate": "2026-03-01"
  }
}'
JSON
{
  "lineId": "<UUID of the product ID>",
  "type": "POLICY_EVENT_RECORD",
  "payload": {
    "policyId": "<UUID of the policy ID>",
    "type": "NOTE",
    "label": "<Label>",
    "description": "<Description>",
    "effectiveDate": "2026-03-01"
  }
}

Request Fields#

See the shared event envelope. Set type to POLICY_EVENT_RECORD and provide the payload below.

Payload Fields#

PropertyRequiredDescription
policyIdYesTarget policy identifier to append the event to.
typeNoBusiness type of the policy event.
labelNoShort label or title for the event.
descriptionNoDescription or notes for the event.
effectiveDateYesDate (YYYY-MM-DD) the event is effective on.

Response#

This example illustrates the common trigger response structure. Action counts and metadata depend on the actions that run; action-specific result fields are described where applicable.

JSON
{
  "triggerRequestId": "<UUID of the trigger request ID>",
  "executedActionCount": 0,
  "expectedResponseCount": 0,
  "metadata": {}
}

Response Fields#

PropertyDescription
triggerRequestIdUUID identifying this trigger execution.
executedActionCountNumber of actions reported as executed.
expectedResponseCountNumber of expected action responses.
metadataAction-specific results; may be empty.

See Firing an Event for execution modes and response handling.