Event Stream API¶
Note
See the Event Stream Feature Guide for more information about using this feature.
GET /eventstream/events| Name | Position | Type | Required |
|---|---|---|---|
endTimestamp | query | integer | optional |
eventType | query | string | optional |
pageSize | query | integer | optional |
pagingToken | query | string | optional |
startTimestamp | query | integer | optional |
EventPageResponseGET /eventstream/attributedEvents| Name | Position | Type | Required |
|---|---|---|---|
endTimestamp | query | integer | optional |
eventType | query | string | optional |
pageSize | query | integer | optional |
pagingToken | query | string | optional |
startTimestamp | query | integer | optional |
EventPageResponseNote
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.
requiredevents[EventResponse]optionalpagingTokenstring
requireddataEventStreamDataidstringtimestamptimestamptypestring 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.reverseoptionalusernamestring
no fields
The data contained in EventStreamData depends on the type field from Event.
Login¶
login.success: EventStreamLoginDatalogin.failure: EventStreamLoginFailureData
Policyholders¶
policyholder.create: EventStreamPolicyholderCreateDatapolicyholder.update: EventStreamPolicyholderUpdateData
Policies¶
policy.create: EventStreamPolicyCreateDatapolicy.update: EventStreamPolicyUpdateDatapolicy.finalize: EventStreamPolicyFinalizeDatapolicy.issue: EventStreamPolicyIssueDatapolicy.cancel: EventStreamPolicyCancelDatapolicy.end: EventStreamPolicyEndDatapolicy.discard: EventStreamPolicyDiscardDatapolicy.end.reminder: EventStreamPolicyEndReminderDatapolicy.gracePeriod: EventStreamGracePeriodCreateDatapolicy.lapse: EventStreamPolicyLapseData (Legacy)policy.reinstatement.openEventStreamReinstatementOpenData (Legacy)policy.reinstatement.invoiceEventStreamReinstatementInvoiceData (Legacy)policy.reinstatement.closeEventStreamReinstatementCloseData (Legacy)
Quotes¶
policy.quote.create: EventStreamPolicyQuoteCreateDatapolicy.quote.update: EventStreamPolicyQuoteUpdateDatapolicy.quote.quoted: EventStreamPolicyQuoteQuotedDatapolicy.quote.accept: EventStreamPolicyQuoteAcceptDatapolicy.quote.declined: EventStreamPolicyQuoteDeclinedDatapolicy.quote.discard: EventStreamPolicyQuoteDiscardData
Endorsements¶
endorsement.create: EventStreamEndorsementCreateDataendorsement.update: EventStreamEndorsementUpdateDataendorsement.accept: EventStreamEndorsementAcceptDataendorsement.issue: EventStreamEndorsementIssueDataendorsement.invalidate: EventStreamEndorsementInvalidateDataendorsement.discard: EventStreamEndorsementDiscardDatapolicy.endorse: EventStreamPolicyEndorseData (Legacy)
Renewals¶
renewal.create: EventStreamRenewalCreateDatarenewal.update: EventStreamRenewalUpdateDatarenewal.accept: EventStreamRenewalAcceptDatarenewal.issue: EventStreamRenewalIssueDatarenewal.invalidate: EventStreamRenewalInvalidateDatarenewal.discard: EventStreamRenewalDiscardDatapolicy.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.closeEventStreamClaimCloseDataclaim.createEventStreamClaimCreateDataclaim.discardEventStreamClaimDiscardDataclaim.openEventStreamClaimOpenDataclaim.updateEventStreamClaimUpdateData
SubClaims¶
subClaim.openEventStreamSubClaimOpenDatasubClaim.updateEventStreamSubClaimUpdateDatasubClaim.closeEventStreamSubClaimCloseDatasubClaim.reopenEventStreamSubClaimReOpenDatasubClaim.updateReserveEventStreamSubClaimReserveUpdateDatasubClaim.createPayableEventStreamSubClaimPayableCreateDatasubClaim.reversePayableEventStreamSubClaimPayableReverseData
Invoicing and Payments¶
invoice.issue: EventStreamPolicyInvoiceIssueDatapayment.pay: EventStreamPaymentPayDatapayment.reverse: EventStreamPaymentReverseData