Skip to content

PRE_CANCELLATION_ISSUED

Indicates that a pre‑cancellation notice has been issued for a policy.
This trigger is produced by the policy service when a PRE_CANCELLATION_NOTICE_SENT policy event is activated, and it notifies downstream systems with a full context payload (policy, event, documents).

When and what fires this event?

  • Internally: Fired by the Policy service after it activates a policy event of type PRE_CANCELLATION_NOTICE_SENT, mapping it to the trigger type PRE_CANCELLATION_ISSUED.
  • Externally via API: Can be fired on‑demand if an integration needs to notify other systems that a pre‑cancellation notice has been issued.

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_ISSUED",
  "payload": {
    "policyId": "<UUID of the policy>",
    "clientId": "<UUID of the client>",
    "policy": { /* PolicyDto snapshot */ },
    "event": {  /* PolicyEventDto for PRE_CANCELLATION_NOTICE_SENT */ },
    "documents": [
      {
        "name": "Notice.pdf",
        "extension": "pdf",
        "contentId": "<CMS-CONTENT-ID>",
        "url": "https://public.cdn/<...>"
      }
    ]
  }
}'
{
  "lineId": "262e67be-c08c-43c0-bb51-06fe4408b4e9",
  "type": "PRE_CANCELLATION_ISSUED",
  "payload": {
    "policyId": "b31e1d1e-31e0-4d9a-9a86-7f9d0a1a2b33",
    "clientId": "220c4020-7f20-4a16-ba51-d0945804dd83",
    "policy": { },
    "event": { },
    "documents": [
      {
        "name": "Notice.pdf",
        "extension": "pdf",
        "contentId": "<CMS-CONTENT-ID>",
        "url": "https://public.cdn/<...>"
      }
    ]
  }
}

Request fields

PropertyRequiredDescription
lineIdtrueUUID for the product.
typetrueMust be PRE_CANCELLATION_ISSUED.
payloadtrueSee below.

Payload fields

PropertyRequiredDescription
policyIdtruePolicy identifier tied to the pre‑cancellation.
clientIdtrueClient identifier associated with the policy.
policytrueSnapshot at the time of activation.
eventtrueRepresentation of the PRE_CANCELLATION_NOTICE_SENT event.
documents[]falseAny documents associated with the event (e.g., notice PDF).

Response json

On success, a standard trigger response is returned. This event is a notification and may not add custom metadata by itself; any metadata present is produced by actions configured to handle this trigger.

{
  "triggerRequestId": "<UUID>",
  "executedActionCount": 0,
  "expectedResponseCount": 0,
  "metadata": { }
}

Response fields

PropertyRequiredDescription
triggerRequestIdtrueUUID that identifies the execution of the trigger.
executedActionCounttrueNumber of actions executed by this trigger. A value of 0 indicates that no actions were run.
expectedResponseCounttrueNumber of responses expected from the executed actions.
metadatatrueAlways present as an object. In this case, it is empty ({}).

Actual counts depend on the actions subscribed to PRE_CANCELLATION_ISSUED in your environment.