Event Stream API¶
Fetch events¶
GET /eventstream/events
Request:
Name
Position
Type
Required
endTimestamp
query
integer
optional
eventType
query
string
optional
pageSize
query
integer
optional
pagingToken
query
string
optional
startTimestamp
query
integer
optional
Response:
EventPageResponse
Fetch attributed events¶
GET /eventstream/attributedEvents
Request:
Name
Position
Type
Required
endTimestamp
query
integer
optional
eventType
query
string
optional
pageSize
query
integer
optional
pagingToken
query
string
optional
startTimestamp
query
integer
optional
Response:
EventPageResponse
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¶
{// Requiredevents : [EventResponse]// OptionalpagingToken : string}
Note
For the first call to fetch events, do not include a pagingToken
; instead include at least one filter criterion, such as startTimestamp
or eventType
.
The EventPageResponse
will always include a pagingToken
. You can use the pagingToken
to get additional results for the same query. When making a call using the pagingToken
, omit the original filter criteria. The pagingToken
lasts forever: even if you reached the end of the result set, you can save the pagingToken
to check for more results later.
On each call to the Event Stream, a different pagingToken
may be returned.
EventResponse¶
{// Requireddata : EventStreamDataid : stringtimestamp : timestamptype : string 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 | 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 | reinstatement.accept | reinstatement.create | reinstatement.issue | reinstatement.invalidate | reinstatement.deadlineReached | renewal.create | renewal.update | renewal.quote | renewal.accept | renewal.issue | 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 | login.success | login.failure | policyholder.create | policyholder.update | payment.reverse// Optionalusername : string}
EventStreamData¶
{no fields}
The data contained in EventStreamData
depends on the type
field from Event
.
Login¶
login.success
: EventStreamLoginData
login.failure
: EventStreamLoginFailureData
Policyholders¶
policyholder.create
: EventStreamPolicyholderCreateData
policyholder.update
: EventStreamPolicyholderUpdateData
Policies¶
policy.create
: EventStreamPolicyCreateData
policy.update
: EventStreamPolicyUpdateData
policy.finalize
: EventStreamPolicyFinalizeData
policy.issue
: EventStreamPolicyIssueData
policy.cancel
: EventStreamPolicyCancelData
policy.end
: EventStreamPolicyEndData
policy.discard
: EventStreamPolicyDiscardData
policy.end.reminder
: EventStreamPolicyEndReminderData
policy.gracePeriod
: EventStreamGracePeriodCreateData
policy.lapse
: EventStreamPolicyLapseData (Legacy)
policy.reinstatement.open
EventStreamReinstatementOpenData (Legacy)
policy.reinstatement.invoice
EventStreamReinstatementInvoiceData (Legacy)
policy.reinstatement.close
EventStreamReinstatementCloseData (Legacy)
Quotes¶
policy.quote.create
: EventStreamPolicyQuoteCreateData
policy.quote.update
: EventStreamPolicyQuoteUpdateData
policy.quote.quoted
: EventStreamPolicyQuoteQuotedData
policy.quote.accept
: EventStreamPolicyQuoteAcceptData
policy.quote.declined
: EventStreamPolicyQuoteDeclinedData
policy.quote.discard
: EventStreamPolicyQuoteDiscardData
Endorsements¶
endorsement.create
: EventStreamEndorsementCreateData
endorsement.update
: EventStreamEndorsementUpdateData
endorsement.accept
: EventStreamEndorsementAcceptData
endorsement.issue
: EventStreamEndorsementIssueData
policy.endorse
: EventStreamPolicyEndorseData (Legacy)
Renewals¶
renewal.create
: EventStreamRenewalCreateData
renewal.update
: EventStreamRenewalUpdateData
renewal.accept
: EventStreamRenewalAcceptData
renewal.issue
: EventStreamRenewalIssueData
policy.renew
: EventStreamRenewalData (Legacy)
Cancellations¶
cancellation.create
: EventStreamCancellationCreateDatacancellation.update
: EventStreamCancellationUpdateDatacancellation.rescind
: EventStreamCancellationRescindDatacancellation.issue
: EventStreamCancellationIssueData
Reinstatements¶
reinstatement.create
: EventStreamReinstatementCreateDatareinstatement.accept
: EventStreamReinstatementAcceptDatareinstatement.issue
: EventStreamReinstatementIssueDatareinstatement.invalidate
: EventStreamReinstatementInvalidateDatareinstatement.deadlineReached
: EventStreamReinstatementDeadlineReachedData
Claims¶
claim.close
EventStreamClaimCloseData
claim.create
EventStreamClaimCreateData
claim.discard
EventStreamClaimDiscardData
claim.open
EventStreamClaimOpenData
claim.update
EventStreamClaimUpdateData
SubClaims¶
subClaim.open
EventStreamSubClaimOpenData
subClaim.update
EventStreamSubClaimUpdateData
subClaim.close
EventStreamSubClaimCloseData
subClaim.reopen
EventStreamSubClaimReOpenData
subClaim.updateReserve
EventStreamSubClaimReserveUpdateData
subClaim.createPayable
EventStreamSubClaimPayableCreateData
subClaim.reversePayable
EventStreamSubClaimPayableReverseData
Invoicing and Payments¶
invoice.issue
: EventStreamPolicyInvoiceIssueData
payment.pay
: EventStreamPaymentPayData
payment.reverse
: EventStreamPaymentReverseData
EventStreamPolicyUpdateData¶
{// RequiredpolicyLocator : string}
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.
EventStreamPolicyEndReminderData¶
{// RequiredpolicyEndTimestamp : timestamppolicyLocator : stringreminderName : string}
EventStreamReinstatementOpenData¶
{// RequiredpolicyLocator : stringreinstatementLocator : string}
EventStreamReinstatementInvoiceData¶
{// RequiredinvoiceLocator : stringpolicyLocator : stringreinstatementLocator : string}
EventStreamReinstatementCloseData¶
{// RequiredpolicyLocator : stringreinstatementLocator : string}
EventStreamSubClaimOpenData¶
{// RequiredclaimLocator : stringpolicyLocator : stringsubClaimLocator : string}
EventStreamSubClaimUpdateData¶
{// RequiredclaimLocator : stringpolicyLocator : stringsubClaimLocator : string}
EventStreamSubClaimCloseData¶
{// RequiredclaimLocator : stringpolicyLocator : stringsubClaimLocator : string}
EventStreamSubClaimReOpenData¶
{// RequiredclaimLocator : stringpolicyLocator : stringsubClaimLocator : string}
EventStreamSubClaimReserveUpdateData¶
{// RequiredclaimLocator : stringpolicyLocator : stringreserveCurrency : stringreserveType : string loss | expensesubClaimLocator : string// OptionalnewAmount : numberoldAmount : number}
EventStreamSubClaimPayableCreateData¶
{// RequiredclaimLocator : stringpayableLocator : stringpolicyLocator : stringsubClaimLocator : string// OptionalamountChange : numberreserveCurrency : stringreserveType : string loss | expense}
EventStreamSubClaimPayableReverseData¶
{// RequiredclaimLocator : stringpolicyLocator : stringreversalLocator : stringreversedLocator : stringsubClaimLocator : string// OptionalamountChange : numberreserveCurrency : stringreserveType : string loss | expense}
EventStreamPaymentPayData¶
{// RequiredinvoiceLocator : stringpaymentLocator : stringpolicyLocator : string}
EventStreamPaymentReverseData¶
{// RequiredinvoiceLocator : stringpaymentLocator : stringpolicyLocator : string}
EventStreamEndorsementCreateData¶
{// RequiredendorsementLocator : stringendorsementName : stringpolicyLocator : stringpolicyModificationLocator : string}
EventStreamEndorsementUpdateData¶
{// RequiredendorsementLocator : stringendorsementName : stringpolicyLocator : stringpolicyModificationLocator : string}
EventStreamEndorsementAcceptData¶
{// RequiredendorsementLocator : stringendorsementName : stringpolicyLocator : stringpolicyModificationLocator : string}
EventStreamEndorsementIssueData¶
{// RequiredendorsementLocator : stringendorsementName : stringpolicyLocator : stringpolicyModificationLocator : string}
EventStreamPolicyEndorseData¶
{// RequiredendorsementName : stringmodificationLocator : stringpolicyLocator : string}
EventStreamRenewalCreateData¶
{// RequiredendTimestamp : timestamppolicyLocator : stringpolicyModificationLocator : stringrenewalLocator : stringstartTimestamp : timestamp}
EventStreamRenewalUpdateData¶
{// RequiredendTimestamp : timestamppolicyLocator : stringpolicyModificationLocator : stringrenewalLocator : stringstartTimestamp : timestamp}
EventStreamRenewalAcceptData¶
{// RequiredendTimestamp : timestamppolicyLocator : stringpolicyModificationLocator : stringrenewalLocator : stringstartTimestamp : timestamp}
EventStreamRenewalIssueData¶
{// RequiredendTimestamp : timestamppolicyLocator : stringpolicyModificationLocator : stringrenewalLocator : stringstartTimestamp : timestamp}
EventStreamRenewalData¶
{// RequiredendTimestamp : timestampmodificationLocator : stringpolicyLocator : stringstartTimestamp : timestamp}
EventStreamCancellationCreateData¶
{// RequiredcancellationLocator : stringmodificationName : stringpolicyLocator : string}
EventStreamCancellationUpdateData¶
{// RequiredcancellationLocator : stringmodificationName : stringpolicyLocator : string}
EventStreamCancellationRescindData¶
{// RequiredcancellationLocator : stringmodificationName : stringpolicyLocator : string}
EventStreamCancellationIssueData¶
{// RequiredcancellationLocator : stringmodificationName : stringpolicyLocator : string}
EventStreamReinstatementCreateData¶
{// RequiredcancellationLocator : stringpolicyLocator : stringreinstatementLocator : string}
EventStreamReinstatementAcceptData¶
{// RequiredcancellationLocator : stringpolicyLocator : stringreinstatementLocator : string}
EventStreamReinstatementIssueData¶
{// RequiredpolicyLocator : stringreinstatementLocator : string// OptionalcancellationLocator : string}
EventStreamReinstatementInvalidateData¶
{// RequiredcancellationLocator : stringpolicyLocator : stringreinstatementLocator : string}
EventStreamReinstatementDeadlineReachedData¶
{// RequiredcancellationLocator : stringpolicyLocator : stringreinstatementLocator : string}