Socotra
Configuration GuideConfiguration General Topics

Event Definitions

This topic lists the details about events returned from the Events API.

Account Events

Quote Events

Policy Status Events

Transaction Events

Policy Static Data Events

Policy Events

Numbering Events

Config Migration Events

Credit Distribution Events

Delinquency Event Events

Delinquency Events

Disbursement Events

Installment Events

Invoice Events

Billing Numbering Events

Payment Events

Shortfall Credit Events

Write Off Events

Hold Events

Document Events

Migration Events

User Association Events

Moratorium Events

Fnol Events

Contact Events

Producer Events

Producer Code Events

Producer Appointment Events

Producer License Events

Event Payloads

AccountEventData

Required properties

PropertyTypeDescription
accountLocatorulid
QuoteEventData

Required properties

PropertyTypeDescription
quoteLocatorulid
QuoteUnderwrittenEventData

Required properties

PropertyTypeDescription
quoteLocatorulid
underwritingStatusEnum info | block | decline | reject | approve
QuoteManuallyUnderwrittenEventData

Required properties

PropertyTypeDescription
quoteLocatorulid
TransactionEventData

Required properties

PropertyTypeDescription
policyLocatorulid
transactionLocatorulid
TransactionUnderwritingEventData

Required properties

PropertyTypeDescription
policyLocatorulid
transactionLocatorulid
underwritingStatusstring
TransactionManualUnderwritingEventData

Required properties

PropertyTypeDescription
policyLocatorulid
transactionLocatorulid
DelinquencyEventData

Required properties

PropertyTypeDescription
delinquencyLocatorulid
policyLocatorsListPageResponseULID
DelinquencyEventEventData

Required properties

PropertyTypeDescription
delinquencyEventLocatorulid
delinquencyLocatorulid
policyLocatorsListPageResponseULID
ShortfallEventData

Required properties

PropertyTypeDescription
shortfallCreditLocatorulid
PaymentEventData

Required properties

PropertyTypeDescription
paymentLocatorulid
policyLocatorsListPageResponseULID
DisbursementEventData

Required properties

PropertyTypeDescription
disbursementLocatorulid
InstallmentLatticeCreateData

Required properties

PropertyTypeDescription
installmentLatticeLocatorulid
CreditDistributionEventData

Required properties

PropertyTypeDescription
creditLocatorulid
InvoiceGeneratedEventData

Required properties

PropertyTypeDescription
accountLocatorulid
invoiceLocatorulid
generateTimedatetime
policyLocatorsListPageResponseULID
InvoiceSettledEventData

Required properties

PropertyTypeDescription
accountLocatorulid
invoiceLocatorulid
policyLocatorsListPageResponseULID
InvoiceAutopayData

Required properties

PropertyTypeDescription
accountLocatorulid
invoiceLocatorulid
autopayTimedatetime
policyLocatorsListPageResponseULID
WriteOffEventData

Required properties

PropertyTypeDescription
writeOffLocatorulid
policyLocatorsListPageResponseULID
PolicyStatusEventData

Required properties

PropertyTypeDescription
policyLocatorulid
newStatusesListPageResponsePolicyStatus
removedStatusesListPageResponsePolicyStatus
NumberingEventData

Required properties

PropertyTypeDescription
entityLocatorulid
MigrationEventData

Required properties

PropertyTypeDescription
migrationLocatorulid
DocumentEventData

Required properties

PropertyTypeDescription
documentLocatorulid
referenceLocatorulid
referenceTypeEnum quote | policy | invoice | transaction | segment | term
FnolEventData

Required properties

PropertyTypeDescription
locatorulid
FnolClaimData

Required properties

PropertyTypeDescription
claimLocatorulid
fnolLocatorulid
HoldEventData

Required properties

PropertyTypeDescription
holdLocatorulid
UserAssociationEventData

Required properties

PropertyTypeDescription
referenceLocatorulid
userAssociationLocatorulid
referenceTypeEnum account | quickQuote | quote | policy | transaction | invoice | underwritingFlag | payment | quoteGroup | inquiry
ContactEventData

Required properties

PropertyTypeDescription
locatorulid
staticLocatorulid
ContactMergeEventData

Required properties

PropertyTypeDescription
newStaticLocatorulid
oldStaticLocatorulid
MoratoriumEventData

Required properties

PropertyTypeDescription
namestring
effectiveTimedatetime
endTimedatetime
ProducerEventData

Required properties

PropertyTypeDescription
producerLocatorulid
ProducerCodeEventData

Required properties

PropertyTypeDescription
producerCodeLocatorulid

Optional properties

PropertyTypeDescription
codestring?
ConfigMigrationEvents

Properties

PropertyTypeDescription
account.config.migration.failedConfigMigrationEventPayload?
policy.config.migration.failedPolicyConfigMigrationEventPayload?
quote.config.migration.failedConfigMigrationEventPayload?
ConfigMigrationEventPayload

Required properties

PropertyTypeDescription
locatorulid
configVersionulid
PolicyConfigMigrationEventPayload

Required properties

PropertyTypeDescription
policyLocatorulid
transactionLocatorulid
configVersionulid
QuotePolicyNumberData

Required properties

PropertyTypeDescription
quoteLocatorulid
quoteStateEnum draft | validated | earlyUnderwritten | priced | underwritten | accepted | issued | underwrittenBlocked | declined | rejected | refused | discarded
NumberingData

Required properties

PropertyTypeDescription
entityLocatorulid
PolicyLocatorData

Required properties

PropertyTypeDescription
policyLocatorulid
PolicyEvents

Properties

PropertyTypeDescription
policy.anonymizePolicyLocatorData?
policy.migrateOnRenewal.disablePolicyLocatorData?
policy.migrateOnRenewal.enablePolicyLocatorData?
PolicyStaticDataEvents

Properties

PropertyTypeDescription
policy.staticdata.addPolicyLocatorData?
policy.staticdata.anonymizePolicyLocatorData?
policy.staticdata.replacePolicyLocatorData?
policy.staticdata.updatePolicyLocatorData?
ProducerLicenseEventData

Required properties

PropertyTypeDescription
producerLicenseLocatorulid
ProducerAppointmentEventData

Required properties

PropertyTypeDescription
producerAppointmentLocatorulid

See Also

On this page