Skip to content

PRE_CANCELLATION_VOIDED

This event is fired when a policy pre-cancellation has been voided.
It indicates that a previously initiated pre-cancellation process was cancelled or invalidated, and the policy remains active.

When and what fires this event?

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

  • Copilot: fires when a pre-cancellation is invalidated;
  • 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 '{
  "lineId": "<UUID of the product>",
  "type": "PRE_CANCELLATION_VOIDED",
  "payload": {
      "policyId": "<UUID of the policy>",
      "clientId": "<UUID of the client>",
      "documents": [],
      "event": {
        "eventId": "<UUID>",
        "type": "PRE_CANCELLATION_VOIDED",
        "label": "<string>",
        "description": "<string>"
      },
      "policy": {
        "id": "<UUID>",
        "policyNumber": "<string>"
      }
  }
}'

Request fields

PropertyRequiredDescription
lineIdtrueUUID for the product the policy belongs to
typetrueMust be set to PRE_CANCELLATION_VOIDED
payloadtrueExplained below

Payload fields

PropertyRequiredDescription
policyIdtrueUUID of the policy affected by the voided pre-cancellation.
clientIdfalseUUID of the client associated with the policy.
documentsfalseList of documents related to the event.
eventfalseElement that contains event details.
policyfalseElement that contains policy information.

Event fields

PropertyRequiredDescription
eventIdfalseUUID of the event.
typefalseType of the event (PRE_CANCELLATION_VOIDED).
labelfalseLabel for the event.
descriptionfalseDescription of the event.

Policy fields

PropertyRequiredDescription
idfalseUUID of the policy.
policyNumberfalsePolicy number.

Response json

{
  "success": true,
  "message": "Event fired successfully",
  "data": {
    "triggerRequestId": "0b8b2e30-5c7a-4d47-bd34-3d7fb34c6f22",
    "executedActionCount": 2,
    "expectedResponseCount": 1
  },
  "timestamp": "2025-01-17T12:00:00.000Z"
}

Response fields

This response represents the standard event-firing wrapper returned by the service.

PropertyRequiredDescription
successtrueIndicates whether the event firing request completed successfully.
messagetrueMessage describing the result of the operation.
datatrueContains metadata about the trigger execution (see below).
timestamptrueTimestamp indicating when the response was generated.

Data fields

The data object contains detailed information about the executed trigger.

PropertyRequiredDescription
triggerRequestIdtrueUUID that uniquely identifies the trigger execution instance.
executedActionCounttrueNumber of workflow actions executed during this trigger run.
expectedResponseCounttrueNumber of responses expected from the executed workflow actions.