RENEWAL_CANCELLED

This event is fired when a policy renewal is cancelled.
It indicates that the system has successfully cancelled the renewal process for a policy and logs this as a non-renewal event.

When and what fires this event?

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

System: fires this event automatically when a policy renewal is cancelled;
Automation: triggers notifications such as emails or webhooks according to the configured actions;
Event payload: includes contextual information about the client, policy, and the cancellation details.

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": "RENEWAL_CANCELLED",
  "payload": {
    "policyId": "<UUID>",
    "clientId": "<UUID, optional>",
    "quoteId": "<UUID, optional>",
    "documents": [],
    "configId": "<UUID>",
    "label": "<string>",
    "backofficeIntake": {}
  }
}'

{
  "type": "RENEWAL_CANCELLED",
  "payload": {
    "policyId": "a1213f1b-0a41-4f9e-97c8-30ce21aa87b1",
    "clientId": "c07a0db0-0667-46b1-ad8b-d1a19829f03e",
    "quoteId": "b2324g2c-1b52-5g0f-98d9-41df32bb98c2",
    "documents": [],
    "configId": "c3435h3d-2c63-6h1g-a9e0-52eg43cc09d3",
    "label": "Renewal cancelled by client request",
    "backofficeIntake": {
      "reason": "Client requested cancellation",
      "cancelledBy": "agent@example.com"
    }
  }
}

Request fields

Property	Required	Description
`type`	`true`	Must be set to `RENEWAL_CANCELLED`.
`payload`	`true`	Object containing event-specific data.

Payload fields

Property	Required	Type	Description
`policyId`	true	UUID	Unique identifier of the policy.
`clientId`	false	UUID	UUID of the client associated with the policy
`quoteId`	false	UUID	UUID of the quote
`documents`	false	Array	List of document.
`configId`	true	UUID	Configuration identifier related to the policy renewal.
`label`	false	String	Optional label or reason for the renewal cancellation.
`backofficeIntake`	false	Map	Optional key-value map with backoffice data or form inputs.

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.