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
Config Migration Events
account.config.migration.failed: ConfigMigrationEventPayloadpolicy.config.migration.failed: PolicyConfigMigrationEventPayloadquote.config.migration.failed: ConfigMigrationEventPayload
Numbering Events
account.numberAssignmentFailed: NumberingDatapolicy.numberAssignmentFailed: NumberingDatapolicy.quote.policyNumberAssigned: NumberingDatapolicy.quote.policyNumberRequested: QuotePolicyNumberDataquote.numberAssignmentFailed: NumberingDataterm.numberAssignmentFailed: NumberingData
Policy Events
policy.anonymize: PolicyLocatorDatapolicy.migrateOnRenewal.disable: PolicyLocatorDatapolicy.migrateOnRenewal.enable: PolicyLocatorData
Policy Static Data Events
policy.staticdata.add: PolicyLocatorDatapolicy.staticdata.anonymize: PolicyLocatorDatapolicy.staticdata.replace: PolicyLocatorDatapolicy.staticdata.update: PolicyLocatorData
Policy Status Events
policy.status.update: PolicyStatusEventData
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
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
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
Hold Events
billing.hold.activate: HoldEventDatabilling.hold.create: HoldEventDatabilling.hold.discard: HoldEventDatabilling.hold.release: HoldEventDatabilling.hold.reset: HoldEventDatabilling.hold.validate: HoldEventData
Installment Events
billing.installmentlattice.create: InstallmentLatticeCreateData
Invoice Events
billing.invoice.autopay: InvoiceAutopayDatabilling.invoice.autopayfailed: InvoiceAutopayDatabilling.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
Document Events
document.failed: DocumentEventDatadocument.ready: DocumentEventData
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
Contact Events
contact.anonymized: ContactEventDatacontact.created: ContactEventDatacontact.merged: ContactMergeEventDatacontact.validated: ContactEventData
Producer Appointment Events
producers.producerappointment.create: ProducerAppointmentEventDataproducers.producerappointment.discard: ProducerAppointmentEventDataproducers.producerappointment.update: ProducerAppointmentEventDataproducers.producerappointment.validate: ProducerAppointmentEventData
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 Events
producers.producer.create: ProducerEventDataproducers.producer.discard: ProducerEventDataproducers.producer.retire: ProducerEventDataproducers.producer.suspend: ProducerEventDataproducers.producer.unsuspend: ProducerEventDataproducers.producer.update: ProducerEventDataproducers.producer.validate: ProducerEventData
Producer License Events
producers.producerlicense.create: ProducerLicenseEventDataproducers.producerlicense.discard: ProducerLicenseEventDataproducers.producerlicense.update: ProducerLicenseEventDataproducers.producerlicense.validate: ProducerLicenseEventData
Event Payloads
Note
A maximum of 5 locators will be returned by event payloads that return a list of locators, such as the policyLocators field in InvoiceGeneratedEventData.
requiredaccountLocator string
requiredquoteLocator string
requiredquoteLocator stringunderwritingStatus Enum info | block | decline | reject | approve
requiredquoteLocator string
requiredpolicyLocator stringtransactionLocator string
requiredpolicyLocator stringtransactionLocator stringunderwritingStatus string
requiredpolicyLocator stringtransactionLocator string
requireddelinquencyLocator stringpolicyLocators ListPageResponseULID
requireddelinquencyEventLocator stringdelinquencyLocator stringpolicyLocators ListPageResponseULID
requiredshortfallCreditLocator string
requiredpaymentLocator stringpolicyLocators ListPageResponseULID
requireddisbursementLocator string
requiredinstallmentLatticeLocator string
requiredcreditLocator string
requiredaccountLocator stringinvoiceLocator stringgenerateTime datetimepolicyLocators ListPageResponseULID
requiredaccountLocator stringinvoiceLocator stringpolicyLocators ListPageResponseULID
requiredaccountLocator stringinvoiceLocator stringautopayTime datetimepolicyLocators ListPageResponseULID
requiredwriteOffLocator stringpolicyLocators ListPageResponseULID
requiredpolicyLocator stringnewStatuses ListPageResponsePolicyStatusremovedStatuses ListPageResponsePolicyStatus
requiredentityLocator string
requiredmigrationLocator string
requireddocumentLocator stringreferenceLocator stringreferenceType Enum quote | policy | invoice | transaction | segment | term
requiredlocator string
requiredclaimLocator stringfnolLocator string
requiredholdLocator string
requiredreferenceLocator stringuserAssociationLocator stringreferenceType Enum account | quickQuote | quote | policy | transaction | invoice | underwritingFlag | payment | quoteGroup | inquiry
requiredlocator stringstaticLocator string
requirednewStaticLocator stringoldStaticLocator string
requiredname stringeffectiveTime datetimeendTime datetime
requiredproducerLocator string
requiredproducerCodeLocator stringoptionalcode string?
optionalaccount.config.migration.failed ConfigMigrationEventPayload?policy.config.migration.failed PolicyConfigMigrationEventPayload?quote.config.migration.failed ConfigMigrationEventPayload?
requiredlocator stringconfigVersion string
requiredpolicyLocator stringtransactionLocator stringconfigVersion string
requiredquoteLocator stringquoteState Enum draft | validated | earlyUnderwritten | priced | underwritten | accepted | issued | underwrittenBlocked | declined | rejected | refused | discarded
requiredentityLocator string
requiredpolicyLocator string
optionalpolicy.anonymize PolicyLocatorData?policy.migrateOnRenewal.disable PolicyLocatorData?policy.migrateOnRenewal.enable PolicyLocatorData?
optionalpolicy.staticdata.add PolicyLocatorData?policy.staticdata.anonymize PolicyLocatorData?policy.staticdata.replace PolicyLocatorData?policy.staticdata.update PolicyLocatorData?
requiredproducerLicenseLocator string
requiredproducerAppointmentLocator string