ENDORSEMENT_ACTIVATED

This event is fired when an endorsement's effective date is reached, meaning that the endorsement becomes officially active and all related changes are now applied to the policy.

This marks the transition from an endorsed (scheduled) state to an active state, coverage adjustments, updated premiums, or modified policy terms take effect from this point onward.

When and what fires this event?

If this event is defined on a product, and it has actions that are enabled:

API: can fire this event externally on demand.

Request payload

POST: https://api.{ENV}.dais.com/ioi/v3/event/fire

curl --location --request POST 'https://api.{ENV}.dais.com/ioi/v3/event/fire' \
--header 'Authorization: Basic <yourAuthHere>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "type": "ENDORSEMENT_ACTIVATED",
  "payload": {
    "policyId": "<UUID>",
    "clientId": "<UUID, optional>",
    "documents": [],
    "event": {
      "eventId": "<UUID>",
      "type": "ENDORSEMENT_ACTIVATED",
      "label": "<string>",
      "description": "<string>"
    },
    "policy": {
      "id": "<UUID>",
      "policyNumber": "<string>"
    }
  }
}'

{
  "type": "ENDORSEMENT_ACTIVATED",
  "payload": {
    "policyId": "b9a672a3-4b7d-4a6a-bb5f-93a41c8358b0",
    "clientId": "7ccf20f1-29c2-43fb-b61a-876e2e0d6f60",
    "documents": [],
    "event": {
      "eventId": "c1d2e3f4-g5h6-7890-ijkl-mnopqrstuvwx",
      "type": "ENDORSEMENT_ACTIVATED",
      "label": "Endorsement Activated",
      "description": "Endorsement has been activated"
    },
    "policy": {
      "id": "b9a672a3-4b7d-4a6a-bb5f-93a41c8358b0",
      "policyNumber": "POL-2024-004"
    }
  }
}

Request fields

Property	Required	Description
`type`	`true`	Must be set to `ENDORSEMENT_ACTIVATED`.
`payload`	`true`	See Payload fields.

Payload fields

Property	Required	Description
`policyId`	true	UUID of the policy.
`clientId`	false	UUID of the client associated with the policy.
`documents`	false	List of documents related to the event.
`event`	false	Containing event details.
`policy`	false	Containing policy information.

Event object fields

Property	Required	Description
`eventId`	false	UUID of the event.
`type`	false	Type of the event.
`label`	false	Label for the event.
`description`	false	Description of the event.

Policy object fields

Property	Required	Description
`id`	false	UUID of the policy.
`policyNumber`	false	Policy number.

Response json

{
  "triggerRequestId": "386861af-6875-49b2-b38c-c435263039be",
  "executedActionCount": 0,
  "expectedResponseCount": 0,
  "metadata": {}
}

Response fields

Property	Required	Description
`triggerRequestId`	`true`	UUID that uniquely identifies the trigger execution instance.
`executedActionCount`	`true`	Number of actions executed during this trigger run.
`expectedResponseCount`	`true`	Number of responses expected from the executed actions.
`metadata`	`true`	Contains dynamically generated data from executed workflow actions.