Event Definitions
This topic lists the details about events returned from the Events API.
Account Events
policy.account.anonymize: AccountEventDatapolicy.account.create: AccountEventDatapolicy.account.discard: AccountEventDatapolicy.account.update: AccountEventDatapolicy.account.validate: AccountEventData
Quote Events
policy.quote.accept: QuoteEventDatapolicy.quote.anonymize: QuoteEventDatapolicy.quote.create: QuoteEventDatapolicy.quote.discard: QuoteEventDatapolicy.quote.issue: QuoteEventDatapolicy.quote.manualunderwrite: QuoteManuallyUnderwrittenEventDatapolicy.quote.price: QuoteEventDatapolicy.quote.refuse: QuoteEventDatapolicy.quote.reset: QuoteEventDatapolicy.quote.staticdata.add: QuoteEventDatapolicy.quote.staticdata.anonymize: QuoteEventDatapolicy.quote.staticdata.replace: QuoteEventDatapolicy.quote.staticdata.update: QuoteEventDatapolicy.quote.underwrite: QuoteUnderwrittenEventDatapolicy.quote.update: QuoteEventDatapolicy.quote.validate: QuoteEventData
Policy Status Events
policy.status.update: PolicyStatusEventData
Transaction Events
policy.cancellation.accept: TransactionEventDatapolicy.cancellation.create: TransactionEventDatapolicy.cancellation.discard: TransactionEventDatapolicy.cancellation.issue: TransactionEventDatapolicy.cancellation.manualUnderwrite: TransactionManualUnderwritingEventDatapolicy.cancellation.price: TransactionEventDatapolicy.cancellation.refuse: TransactionEventDatapolicy.cancellation.reset: TransactionEventDatapolicy.cancellation.underwrite: TransactionUnderwritingEventDatapolicy.cancellation.update: TransactionEventDatapolicy.cancellation.validate: TransactionEventDatapolicy.change.accept: TransactionEventDatapolicy.change.create: TransactionEventDatapolicy.change.discard: TransactionEventDatapolicy.change.issue: TransactionEventDatapolicy.change.manualUnderwrite: TransactionManualUnderwritingEventDatapolicy.change.price: TransactionEventDatapolicy.change.refuse: TransactionEventDatapolicy.change.reset: TransactionEventDatapolicy.change.underwrite: TransactionUnderwritingEventDatapolicy.change.validate: TransactionEventDatapolicy.reinstatement.accept: TransactionEventDatapolicy.reinstatement.create: TransactionEventDatapolicy.reinstatement.discard: TransactionEventDatapolicy.reinstatement.issue: TransactionEventDatapolicy.reinstatement.manualUnderwrite: TransactionManualUnderwritingEventDatapolicy.reinstatement.price: TransactionEventDatapolicy.reinstatement.refuse: TransactionEventDatapolicy.reinstatement.reset: TransactionEventDatapolicy.reinstatement.underwrite: TransactionUnderwritingEventDatapolicy.reinstatement.update: TransactionEventDatapolicy.reinstatement.validate: TransactionEventDatapolicy.renewal.accept: TransactionEventDatapolicy.renewal.create: TransactionEventDatapolicy.renewal.discard: TransactionEventDatapolicy.renewal.issue: TransactionEventDatapolicy.renewal.manualUnderwrite: TransactionManualUnderwritingEventDatapolicy.renewal.price: TransactionEventDatapolicy.renewal.refuse: TransactionEventDatapolicy.renewal.reset: TransactionEventDatapolicy.renewal.underwrite: TransactionUnderwritingEventDatapolicy.renewal.update: TransactionEventDatapolicy.renewal.validate: TransactionEventDatapolicy.reversal.accept: TransactionEventDatapolicy.reversal.create: TransactionEventDatapolicy.reversal.discard: TransactionEventDatapolicy.reversal.issue: TransactionEventDatapolicy.reversal.manualUnderwrite: TransactionManualUnderwritingEventDatapolicy.reversal.price: TransactionEventDatapolicy.reversal.refuse: TransactionEventDatapolicy.reversal.reset: TransactionEventDatapolicy.reversal.underwrite: TransactionUnderwritingEventDatapolicy.reversal.update: TransactionEventDatapolicy.reversal.validate: TransactionEventData
Policy Static Data Events
policy.staticdata.add: PolicyLocatorDatapolicy.staticdata.anonymize: PolicyLocatorDatapolicy.staticdata.replace: PolicyLocatorDatapolicy.staticdata.update: PolicyLocatorData
Policy Events
policy.anonymize: PolicyLocatorDatapolicy.migrateOnRenewal.disable: PolicyLocatorDatapolicy.migrateOnRenewal.enable: PolicyLocatorData
Numbering Events
account.numberAssignmentFailed: NumberingDatapolicy.numberAssignmentFailed: NumberingDatapolicy.quote.policyNumberAssigned: NumberingDatapolicy.quote.policyNumberRequested: QuotePolicyNumberDataquote.numberAssignmentFailed: NumberingDataterm.numberAssignmentFailed: NumberingData
Config Migration Events
account.config.migration.failed: ConfigMigrationEventPayloadpolicy.config.migration.failed: PolicyConfigMigrationEventPayloadquote.config.migration.failed: ConfigMigrationEventPayload
Credit Distribution Events
billing.creditdistribution.create: CreditDistributionEventDatabilling.creditdistribution.distribute: CreditDistributionEventDatabilling.creditdistribution.reverse: CreditDistributionEventData
Delinquency Event Events
billing.delinquency.delinquencyevent.activate: DelinquencyEventEventDatabilling.delinquency.delinquencyevent.cancel: DelinquencyEventEventDatabilling.delinquency.delinquencyevent.create: DelinquencyEventEventDatabilling.delinquency.delinquencyevent.trigger: DelinquencyEventEventData
Delinquency Events
billing.delinquency.create: DelinquencyEventDatabilling.delinquency.lapse: DelinquencyEventDatabilling.delinquency.settle: DelinquencyEventData
Disbursement Events
billing.disbursement.anonymize: DisbursementEventDatabilling.disbursement.approve: DisbursementEventDatabilling.disbursement.create: DisbursementEventDatabilling.disbursement.execute: DisbursementEventDatabilling.disbursement.reject: DisbursementEventDatabilling.disbursement.reverse: DisbursementEventData
Installment Events
billing.installmentlattice.create: InstallmentLatticeCreateData
Invoice Events
billing.invoice.autopay: InvoiceAutopayDatabilling.invoice.autopayfailed: InvoiceAutopayDatabilling.invoice.discard: InvoiceDiscardDatabilling.invoice.generate: InvoiceGeneratedEventDatabilling.invoice.settle: InvoiceSettledEventDatabilling.invoice.unsettle: InvoiceSettledEventData
Billing Numbering Events
disbursement.numberAssignmentFailed: NumberingEventDatainvoice.numberAssignmentFailed: NumberingEventDatapayment.numberAssignmentFailed: NumberingEventData
Payment Events
billing.payment.anonymize: PaymentEventDatabilling.payment.cancel: PaymentEventDatabilling.payment.create: PaymentEventDatabilling.payment.distribute: PaymentEventDatabilling.payment.execute: PaymentEventDatabilling.payment.fail: PaymentEventDatabilling.payment.post: PaymentEventDatabilling.payment.request: PaymentEventDatabilling.payment.reverse: PaymentEventDatabilling.payment.validationfailed: PaymentEventData
Shortfall Credit Events
billing.shortfallcredit.create: ShortfallEventDatabilling.shortfallcredit.distribute: ShortfallEventDatabilling.shortfallcredit.reverse: ShortfallEventData
Write Off Events
billing.writeoff.create: WriteOffEventDatabilling.writeoff.distribute: WriteOffEventDatabilling.writeoff.reverse: WriteOffEventData
Hold Events
billing.hold.activate: HoldEventDatabilling.hold.create: HoldEventDatabilling.hold.discard: HoldEventDatabilling.hold.release: HoldEventDatabilling.hold.reset: HoldEventDatabilling.hold.validate: HoldEventData
Document Events
document.copyOnIssue.ready: DocumentCopyOnIssueReadyPayloaddocument.failed: DocumentGenerationEventsPayloaddocument.ready: DocumentGenerationEventsPayload
Migration Events
migration.error: MigrationEventDatamigration.fail: MigrationEventDatamigration.finish: MigrationEventDatamigration.patch: MigrationEventDatamigration.pause: MigrationEventDatamigration.recover: MigrationEventDatamigration.resume: MigrationEventDatamigration.start: MigrationEventData
User Association Events
userAssociation.associated: UserAssociationEventDatauserAssociation.completed: UserAssociationEventDatauserAssociation.disassociated: UserAssociationEventDatauserAssociation.uncompleted: UserAssociationEventData
Moratorium Events
moratorium.create: MoratoriumEventDatamoratorium.effective: MoratoriumEventDatamoratorium.end: MoratoriumEventDatamoratorium.update: MoratoriumEventData
Fnol Events
claim.fnol.anonymize: FnolEventDataclaim.fnol.complete: FnolEventDataclaim.fnol.create: FnolEventDataclaim.fnol.discard: FnolEventDataclaim.fnol.onclaim: FnolClaimDataclaim.fnol.reject: FnolEventDataclaim.fnol.update: FnolEventDataclaim.fnol.validate: FnolEventDatafnol.numberAssignmentFailed: FnolEventData
Contact Events
contact.anonymized: ContactEventDatacontact.created: ContactEventDatacontact.merged: ContactMergeEventDatacontact.validated: ContactEventData
Producer Events
producers.producer.create: ProducerEventDataproducers.producer.discard: ProducerEventDataproducers.producer.retire: ProducerEventDataproducers.producer.suspend: ProducerEventDataproducers.producer.unsuspend: ProducerEventDataproducers.producer.update: ProducerEventDataproducers.producer.validate: ProducerEventData
Producer Code Events
producers.producercode.create: ProducerCodeEventDataproducers.producercode.discard: ProducerCodeEventDataproducers.producercode.numberAssignmentFailed: ProducerCodeEventDataproducers.producercode.retire: ProducerCodeEventDataproducers.producercode.suspend: ProducerCodeEventDataproducers.producercode.unsuspend: ProducerCodeEventDataproducers.producercode.update: ProducerCodeEventDataproducers.producercode.validate: ProducerCodeEventData
Producer Appointment Events
producers.producerappointment.create: ProducerAppointmentEventDataproducers.producerappointment.discard: ProducerAppointmentEventDataproducers.producerappointment.update: ProducerAppointmentEventDataproducers.producerappointment.validate: ProducerAppointmentEventData
Producer License Events
producers.producerlicense.create: ProducerLicenseEventDataproducers.producerlicense.discard: ProducerLicenseEventDataproducers.producerlicense.update: ProducerLicenseEventDataproducers.producerlicense.validate: ProducerLicenseEventData
Event Payloads
AccountEventData
Required properties
| Property | Type | Description |
|---|---|---|
accountLocator | ulid |
QuoteEventData
Required properties
| Property | Type | Description |
|---|---|---|
quoteLocator | ulid |
QuoteUnderwrittenEventData
Required properties
| Property | Type | Description |
|---|---|---|
quoteLocator | ulid | |
underwritingStatus | Enum info | block | decline | reject | approve |
QuoteManuallyUnderwrittenEventData
Required properties
| Property | Type | Description |
|---|---|---|
quoteLocator | ulid |
TransactionEventData
Required properties
| Property | Type | Description |
|---|---|---|
policyLocator | ulid | |
transactionLocator | ulid |
TransactionUnderwritingEventData
Required properties
| Property | Type | Description |
|---|---|---|
policyLocator | ulid | |
transactionLocator | ulid | |
underwritingStatus | string |
TransactionManualUnderwritingEventData
Required properties
| Property | Type | Description |
|---|---|---|
policyLocator | ulid | |
transactionLocator | ulid |
DelinquencyEventData
Required properties
| Property | Type | Description |
|---|---|---|
delinquencyLocator | ulid | |
policyLocators | ListPageResponseULID |
DelinquencyEventEventData
Required properties
| Property | Type | Description |
|---|---|---|
delinquencyEventLocator | ulid | |
delinquencyLocator | ulid | |
policyLocators | ListPageResponseULID |
ShortfallEventData
Required properties
| Property | Type | Description |
|---|---|---|
shortfallCreditLocator | ulid |
PaymentEventData
Required properties
| Property | Type | Description |
|---|---|---|
paymentLocator | ulid | |
policyLocators | ListPageResponseULID |
DisbursementEventData
Required properties
| Property | Type | Description |
|---|---|---|
disbursementLocator | ulid |
InstallmentLatticeCreateData
Required properties
| Property | Type | Description |
|---|---|---|
installmentLatticeLocator | ulid |
CreditDistributionEventData
Required properties
| Property | Type | Description |
|---|---|---|
creditLocator | ulid |
InvoiceGeneratedEventData
Required properties
| Property | Type | Description |
|---|---|---|
accountLocator | ulid | |
invoiceLocator | ulid | |
generateTime | datetime | |
invoiceType | Enum normal | aggregate | |
policyLocators | ListPageResponseULID |
InvoiceSettledEventData
Required properties
| Property | Type | Description |
|---|---|---|
accountLocator | ulid | |
invoiceLocator | ulid | |
invoiceType | Enum normal | aggregate | |
policyLocators | ListPageResponseULID |
InvoiceAutopayData
Required properties
| Property | Type | Description |
|---|---|---|
accountLocator | ulid | |
invoiceLocator | ulid | |
autopayTime | datetime | |
invoiceType | Enum normal | aggregate | |
policyLocators | ListPageResponseULID |
InvoiceEvents
Properties
| Property | Type | Description |
|---|---|---|
billing.invoice.autopay | InvoiceAutopayData? | |
billing.invoice.autopayfailed | InvoiceAutopayData? | |
billing.invoice.discard | InvoiceDiscardData? | |
billing.invoice.generate | InvoiceGeneratedEventData? | |
billing.invoice.settle | InvoiceSettledEventData? | |
billing.invoice.unsettle | InvoiceSettledEventData? |
InvoiceDiscardData
Required properties
| Property | Type | Description |
|---|---|---|
accountLocator | ulid | |
invoiceLocator | ulid | |
invoiceType | Enum normal | aggregate |
WriteOffEventData
Required properties
| Property | Type | Description |
|---|---|---|
writeOffLocator | ulid | |
policyLocators | ListPageResponseULID |
PolicyStatusEventData
Required properties
| Property | Type | Description |
|---|---|---|
policyLocator | ulid | |
newStatuses | ListPageResponsePolicyStatus | |
removedStatuses | ListPageResponsePolicyStatus |
NumberingEventData
Required properties
| Property | Type | Description |
|---|---|---|
entityLocator | ulid |
MigrationEventData
Required properties
| Property | Type | Description |
|---|---|---|
migrationLocator | ulid |
DocumentCopyOnIssueReadyPayload
Required properties
| Property | Type | Description |
|---|---|---|
quoteReferenceLocator | ulid |
DocumentGenerationEventsPayload
Required properties
| Property | Type | Description |
|---|---|---|
documentLocator | ulid | |
referenceLocator | ulid | |
referenceType | Enum quote | policy | invoice | transaction | segment | term |
FnolEventData
Required properties
| Property | Type | Description |
|---|---|---|
locator | ulid |
FnolClaimData
Required properties
| Property | Type | Description |
|---|---|---|
claimLocator | ulid | |
fnolLocator | ulid |
HoldEventData
Required properties
| Property | Type | Description |
|---|---|---|
holdLocator | ulid |
UserAssociationEventData
Required properties
| Property | Type | Description |
|---|---|---|
referenceLocator | ulid | |
userAssociationLocator | ulid | |
referenceType | Enum account | quickQuote | quote | policy | transaction | invoice | underwritingFlag | payment | quoteGroup | inquiry |
ContactEventData
Required properties
| Property | Type | Description |
|---|---|---|
locator | ulid | |
staticLocator | ulid |
ContactMergeEventData
Required properties
| Property | Type | Description |
|---|---|---|
newStaticLocator | ulid | |
oldStaticLocator | ulid |
MoratoriumEventData
Required properties
| Property | Type | Description |
|---|---|---|
name | string | |
effectiveTime | datetime | |
endTime | datetime |
ProducerEventData
Required properties
| Property | Type | Description |
|---|---|---|
producerLocator | ulid |
ProducerCodeEventData
Required properties
| Property | Type | Description |
|---|---|---|
producerCodeLocator | ulid |
Optional properties
| Property | Type | Description |
|---|---|---|
code | string? |
ConfigMigrationEvents
Properties
| Property | Type | Description |
|---|---|---|
account.config.migration.failed | ConfigMigrationEventPayload? | |
policy.config.migration.failed | PolicyConfigMigrationEventPayload? | |
quote.config.migration.failed | ConfigMigrationEventPayload? |
ConfigMigrationEventPayload
Required properties
| Property | Type | Description |
|---|---|---|
locator | ulid | |
configVersion | ulid |
PolicyConfigMigrationEventPayload
Required properties
| Property | Type | Description |
|---|---|---|
policyLocator | ulid | |
transactionLocator | ulid | |
configVersion | ulid |
QuotePolicyNumberData
Required properties
| Property | Type | Description |
|---|---|---|
quoteLocator | ulid | |
quoteState | Enum draft | validated | earlyUnderwritten | priced | underwritten | accepted | issued | underwrittenBlocked | declined | rejected | refused | discarded |
NumberingData
Required properties
| Property | Type | Description |
|---|---|---|
entityLocator | ulid |
PolicyLocatorData
Required properties
| Property | Type | Description |
|---|---|---|
policyLocator | ulid |
PolicyEvents
Properties
| Property | Type | Description |
|---|---|---|
policy.anonymize | PolicyLocatorData? | |
policy.migrateOnRenewal.disable | PolicyLocatorData? | |
policy.migrateOnRenewal.enable | PolicyLocatorData? |
PolicyStaticDataEvents
Properties
| Property | Type | Description |
|---|---|---|
policy.staticdata.add | PolicyLocatorData? | |
policy.staticdata.anonymize | PolicyLocatorData? | |
policy.staticdata.replace | PolicyLocatorData? | |
policy.staticdata.update | PolicyLocatorData? |
ProducerLicenseEventData
Required properties
| Property | Type | Description |
|---|---|---|
producerLicenseLocator | ulid |
ProducerAppointmentEventData
Required properties
| Property | Type | Description |
|---|---|---|
producerAppointmentLocator | ulid |