Event Stream API

Note

See the Event Stream Feature Guide for more information about using this feature.

Fetch events
GET /eventstream/events
    Request:

    NamePositionTypeRequired

    endTimestamp

    query

    integer

    optional

    eventType

    query

    string

    optional

    pageSize

    query

    integer

    optional

    pagingToken

    query

    string

    optional

    startTimestamp

    query

    integer

    optional

Fetch attributed events
GET /eventstream/attributedEvents
    Request:

    NamePositionTypeRequired

    endTimestamp

    query

    integer

    optional

    eventType

    query

    string

    optional

    pageSize

    query

    integer

    optional

    pagingToken

    query

    string

    optional

    startTimestamp

    query

    integer

    optional

Note

Fetch events and Fetch attributed events do the same thing except the latter endpoint will include the username of the user that initiated the event as part of the event data.

EventPageResponse
required

optional
pagingTokenstring
EventResponse
required
idstring
timestamptimestamp
typestring cancellation.create | cancellation.update | cancellation.rescind | cancellation.issue | claim.close | claim.create | claim.discard | claim.open | claim.update | policy.gracePeriod | policy.gracePeriod.update | invoice.issue | invoice.invalidate | payment.pay | policy.cancel | policy.create | policy.discard | policy.endorse | policy.finalize | policy.invoice | policy.issue | policy.lapse | policy.reinstatement.close | policy.reinstatement.invoice | policy.reinstatement.issue | policy.reinstatement.open | policy.renew | policy.update | subClaim.open | subClaim.update | subClaim.close | subClaim.reopen | subClaim.updateReserve | policy.end.reminder | subClaim.createPayable | subClaim.reversePayable | endorsement.create | endorsement.update | endorsement.quote | endorsement.accept | endorsement.issue | endorsement.invalidate | endorsement.discard | reinstatement.accept | reinstatement.create | reinstatement.issue | reinstatement.invalidate | reinstatement.deadlineReached | renewal.create | renewal.update | renewal.quote | renewal.accept | renewal.issue | renewal.invalidate | renewal.discard | policy.end | policy.quote.create | policy.quote.discard | policy.quote.update | policy.quote.quoted | policy.quote.accept | policy.quote.declined | premiumReport.create | premiumReport.update | premiumReport.issue | premiumReport.discard | premiumReport.reverse | premiumReport.replace | login.success | login.failure | policyholder.create | policyholder.update | payment.reverse

optional
usernamestring
EventStreamData
no fields

The data contained in EventStreamData depends on the type field from Event.

Login

Policyholders

Policies

Quotes

Endorsements

Renewals

Cancellations

Reinstatements

Invoicing and Payments

Premium Reports

EventStreamLoginData
required
usernamestring
EventStreamLoginFailureData
required
usernamestring
EventStreamPolicyholderCreateData
required
policyholderLocatorstring
EventStreamPolicyholderUpdateData
required
policyholderLocatorstring
EventStreamPolicyCreateData
required
policyLocatorstring
EventStreamPolicyUpdateData
required
policyLocatorstring

Note: The update event will only fire on an explicit call to the update endpoint. It is not fired implicitly when the policy is finalized or issued.

EventStreamPolicyFinalizeData
required
policyLocatorstring
EventStreamPolicyIssueData
required
policyLocatorstring
EventStreamPolicyCancelData
required
modificationNamestring
policyLocatorstring

optional
effectiveTimestamptimestamp
EventStreamPolicyEndData
required
policyEndTimestamptimestamp
policyLocatorstring
EventStreamPolicyDiscardData
required
policyLocatorstring
EventStreamGracePeriodCreateData
required
gracePeriodLocatorstring
policyLocatorstring
EventStreamPolicyEndReminderData
required
policyEndTimestamptimestamp
policyLocatorstring
reminderNamestring
EventStreamPolicyLapseData
required
lapseLocatorstring
policyLocatorstring
EventStreamReinstatementOpenData
required
policyLocatorstring
reinstatementLocatorstring
EventStreamReinstatementInvoiceData
required
invoiceLocatorstring
policyLocatorstring
reinstatementLocatorstring
EventStreamReinstatementCloseData
required
policyLocatorstring
reinstatementLocatorstring
EventStreamPolicyQuoteCreateData
required
policyLocatorstring
quoteLocatorstring
EventStreamPolicyQuoteUpdateData
required
policyLocatorstring
quoteLocatorstring
EventStreamPolicyQuoteQuotedData
required
policyLocatorstring
quoteLocatorstring
EventStreamPolicyQuoteAcceptData
required
policyLocatorstring
quoteLocatorstring
EventStreamPolicyQuoteDeclinedData
required
policyLocatorstring
quoteLocatorstring
EventStreamPolicyQuoteDiscardData
required
policyLocatorstring
quoteLocatorstring
EventStreamClaimCloseData
required
claimLocatorstring
policyLocatorstring
EventStreamClaimCreateData
required
claimLocatorstring
policyLocatorstring
EventStreamClaimDiscardData
required
claimLocatorstring
policyLocatorstring
EventStreamClaimOpenData
required
claimLocatorstring
policyLocatorstring
EventStreamClaimUpdateData
required
claimLocatorstring
policyLocatorstring
EventStreamSubClaimOpenData
required
claimLocatorstring
policyLocatorstring
subClaimLocatorstring
EventStreamSubClaimUpdateData
required
claimLocatorstring
policyLocatorstring
subClaimLocatorstring
EventStreamSubClaimCloseData
required
claimLocatorstring
policyLocatorstring
subClaimLocatorstring
EventStreamSubClaimReOpenData
required
claimLocatorstring
policyLocatorstring
subClaimLocatorstring
EventStreamSubClaimReserveUpdateData
required
claimLocatorstring
policyLocatorstring
reserveCurrencystring
reserveTypestring loss | expense
subClaimLocatorstring

optional
newAmountnumber
oldAmountnumber
EventStreamSubClaimPayableCreateData
required
claimLocatorstring
payableLocatorstring
policyLocatorstring
subClaimLocatorstring

optional
amountChangenumber
reserveCurrencystring
reserveTypestring loss | expense
EventStreamSubClaimPayableReverseData
required
claimLocatorstring
policyLocatorstring
reversalLocatorstring
reversedLocatorstring
subClaimLocatorstring

optional
amountChangenumber
reserveCurrencystring
reserveTypestring loss | expense
EventStreamPaymentPayData
required
invoiceLocatorstring
paymentLocatorstring
policyLocatorstring
EventStreamPaymentReverseData
required
invoiceLocatorstring
paymentLocatorstring
policyLocatorstring
EventStreamPolicyInvoiceIssueData
required
invoiceLocatorstring
policyLocatorstring
EventStreamEndorsementCreateData
required
endorsementLocatorstring
endorsementNamestring
policyLocatorstring
policyModificationLocatorstring
EventStreamEndorsementUpdateData
required
endorsementLocatorstring
endorsementNamestring
policyLocatorstring
policyModificationLocatorstring
EventStreamEndorsementAcceptData
required
endorsementLocatorstring
endorsementNamestring
policyLocatorstring
policyModificationLocatorstring
EventStreamEndorsementIssueData
required
endorsementLocatorstring
endorsementNamestring
policyLocatorstring
policyModificationLocatorstring
EventStreamEndorsementInvalidateData
required
endorsementLocatorstring
policyLocatorstring
EventStreamEndorsementDiscardData
required
endorsementLocatorstring
policyLocatorstring
EventStreamPolicyEndorseData
required
endorsementNamestring
modificationLocatorstring
policyLocatorstring
EventStreamRenewalCreateData
required
endTimestamptimestamp
policyLocatorstring
policyModificationLocatorstring
renewalLocatorstring
startTimestamptimestamp
EventStreamRenewalUpdateData
required
endTimestamptimestamp
policyLocatorstring
policyModificationLocatorstring
renewalLocatorstring
startTimestamptimestamp
EventStreamRenewalAcceptData
required
endTimestamptimestamp
policyLocatorstring
policyModificationLocatorstring
renewalLocatorstring
startTimestamptimestamp
EventStreamRenewalIssueData
required
endTimestamptimestamp
policyLocatorstring
policyModificationLocatorstring
renewalLocatorstring
startTimestamptimestamp
EventStreamRenewalInvalidateData
required
policyLocatorstring
renewalLocatorstring
EventStreamRenewalDiscardData
required
policyLocatorstring
renewalLocatorstring
EventStreamRenewalData
required
endTimestamptimestamp
modificationLocatorstring
policyLocatorstring
startTimestamptimestamp
EventStreamCancellationCreateData
required
cancellationLocatorstring
modificationNamestring
policyLocatorstring

optional
effectiveTimestamptimestamp
EventStreamCancellationUpdateData
required
cancellationLocatorstring
modificationNamestring
policyLocatorstring

optional
effectiveTimestamptimestamp
EventStreamCancellationRescindData
required
cancellationLocatorstring
modificationNamestring
policyLocatorstring

optional
effectiveTimestamptimestamp
EventStreamCancellationIssueData
required
cancellationLocatorstring
modificationNamestring
policyLocatorstring

optional
cancellationNamestring
effectiveTimestamptimestamp
EventStreamReinstatementCreateData
required
cancellationLocatorstring
policyLocatorstring
reinstatementLocatorstring
EventStreamReinstatementAcceptData
required
cancellationLocatorstring
policyLocatorstring
reinstatementLocatorstring
EventStreamReinstatementIssueData
required
policyLocatorstring
reinstatementLocatorstring

optional
cancellationLocatorstring
EventStreamReinstatementInvalidateData
required
cancellationLocatorstring
policyLocatorstring
reinstatementLocatorstring
EventStreamReinstatementDeadlineReachedData
required
cancellationLocatorstring
policyLocatorstring
reinstatementLocatorstring
EventStreamPremiumReportCreateData
required
policyLocatorstring
premiumReportLocatorstring
EventStreamPremiumReportUpdateData
required
policyLocatorstring
premiumReportLocatorstring
EventStreamPremiumReportIssueData
required
policyLocatorstring
premiumReportLocatorstring
EventStreamPremiumReportDiscardData
required
policyLocatorstring
premiumReportLocatorstring