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¶

{
  // Required
  events : [EventResponse]

  // Optional
  pagingToken : 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¶

{
  // Required
  data : EventStreamData
  id : string
  timestamp : timestamp
  type : 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

  // Optional
  username : string
}

EventStreamData¶

{
no fields
}

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

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: EventStreamCancellationCreateData
cancellation.update: EventStreamCancellationUpdateData
cancellation.rescind: EventStreamCancellationRescindData
cancellation.issue: EventStreamCancellationIssueData

Reinstatements¶

reinstatement.create: EventStreamReinstatementCreateData
reinstatement.accept: EventStreamReinstatementAcceptData
reinstatement.issue: EventStreamReinstatementIssueData
reinstatement.invalidate: EventStreamReinstatementInvalidateData
reinstatement.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

Premium Reports¶

premiumReport.create: EventStreamPremiumReportCreateData

premiumReport.update: EventStreamPremiumReportUpdateData

premiumReport.issue: EventStreamPremiumReportIssueData

premiumReport.discard: EventStreamPremiumReportDiscardData

EventStreamLoginData¶

{
  // Required
  username : string
}

EventStreamLoginFailureData¶

{
  // Required
  username : string
}

EventStreamPolicyholderCreateData¶

{
  // Required
  policyholderLocator : string
}

EventStreamPolicyholderUpdateData¶

{
  // Required
  policyholderLocator : string
}

EventStreamPolicyCreateData¶

{
  // Required
  policyLocator : string
}

EventStreamPolicyUpdateData¶

{
  // Required
  policyLocator : 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.

EventStreamPolicyFinalizeData¶

{
  // Required
  policyLocator : string
}

EventStreamPolicyIssueData¶

{
  // Required
  policyLocator : string
}

EventStreamPolicyCancelData¶

{
  // Required
  modificationName : string
  policyLocator : string
}

EventStreamPolicyEndData¶

{
  // Required
  policyEndTimestamp : timestamp
  policyLocator : string
}

EventStreamPolicyDiscardData¶

{
  // Required
  policyLocator : string
}

EventStreamGracePeriodCreateData¶

{
  // Required
  gracePeriodLocator : string
  policyLocator : string
}

EventStreamPolicyEndReminderData¶

{
  // Required
  policyEndTimestamp : timestamp
  policyLocator : string
  reminderName : string
}

EventStreamPolicyLapseData¶

{
  // Required
  lapseLocator : string
  policyLocator : string
}

EventStreamReinstatementOpenData¶

{
  // Required
  policyLocator : string
  reinstatementLocator : string
}

EventStreamReinstatementInvoiceData¶

{
  // Required
  invoiceLocator : string
  policyLocator : string
  reinstatementLocator : string
}

EventStreamReinstatementCloseData¶

{
  // Required
  policyLocator : string
  reinstatementLocator : string
}

EventStreamPolicyQuoteCreateData¶

{
  // Required
  policyLocator : string
  quoteLocator : string
}

EventStreamPolicyQuoteUpdateData¶

{
  // Required
  policyLocator : string
  quoteLocator : string
}

EventStreamPolicyQuoteQuotedData¶

{
  // Required
  policyLocator : string
  quoteLocator : string
}

EventStreamPolicyQuoteAcceptData¶

{
  // Required
  policyLocator : string
  quoteLocator : string
}

EventStreamPolicyQuoteDeclinedData¶

{
  // Required
  policyLocator : string
  quoteLocator : string
}

EventStreamPolicyQuoteDiscardData¶

{
  // Required
  policyLocator : string
  quoteLocator : string
}

EventStreamClaimCloseData¶

{
  // Required
  claimLocator : string
  policyLocator : string
}

EventStreamClaimCreateData¶

{
  // Required
  claimLocator : string
  policyLocator : string
}

EventStreamClaimDiscardData¶

{
  // Required
  claimLocator : string
  policyLocator : string
}

EventStreamClaimOpenData¶

{
  // Required
  claimLocator : string
  policyLocator : string
}

EventStreamClaimUpdateData¶

{
  // Required
  claimLocator : string
  policyLocator : string
}

EventStreamSubClaimOpenData¶

{
  // Required
  claimLocator : string
  policyLocator : string
  subClaimLocator : string
}

EventStreamSubClaimUpdateData¶

{
  // Required
  claimLocator : string
  policyLocator : string
  subClaimLocator : string
}

EventStreamSubClaimCloseData¶

{
  // Required
  claimLocator : string
  policyLocator : string
  subClaimLocator : string
}

EventStreamSubClaimReOpenData¶

{
  // Required
  claimLocator : string
  policyLocator : string
  subClaimLocator : string
}

EventStreamSubClaimReserveUpdateData¶

{
  // Required
  claimLocator : string
  policyLocator : string
  reserveCurrency : string
  reserveType : string loss | expense
  subClaimLocator : string

  // Optional
  newAmount : number
  oldAmount : number
}

EventStreamSubClaimPayableCreateData¶

{
  // Required
  claimLocator : string
  payableLocator : string
  policyLocator : string
  subClaimLocator : string

  // Optional
  amountChange : number
  reserveCurrency : string
  reserveType : string loss | expense
}

EventStreamSubClaimPayableReverseData¶

{
  // Required
  claimLocator : string
  policyLocator : string
  reversalLocator : string
  reversedLocator : string
  subClaimLocator : string

  // Optional
  amountChange : number
  reserveCurrency : string
  reserveType : string loss | expense
}

EventStreamPaymentPayData¶

{
  // Required
  invoiceLocator : string
  paymentLocator : string
  policyLocator : string
}

EventStreamPaymentReverseData¶

{
  // Required
  invoiceLocator : string
  paymentLocator : string
  policyLocator : string
}

EventStreamPolicyInvoiceIssueData¶

{
  // Required
  invoiceLocator : string
  policyLocator : string
}

EventStreamEndorsementCreateData¶

{
  // Required
  endorsementLocator : string
  endorsementName : string
  policyLocator : string
  policyModificationLocator : string
}

EventStreamEndorsementUpdateData¶

{
  // Required
  endorsementLocator : string
  endorsementName : string
  policyLocator : string
  policyModificationLocator : string
}

EventStreamEndorsementAcceptData¶

{
  // Required
  endorsementLocator : string
  endorsementName : string
  policyLocator : string
  policyModificationLocator : string
}

EventStreamEndorsementIssueData¶

{
  // Required
  endorsementLocator : string
  endorsementName : string
  policyLocator : string
  policyModificationLocator : string
}

EventStreamPolicyEndorseData¶

{
  // Required
  endorsementName : string
  modificationLocator : string
  policyLocator : string
}

EventStreamRenewalCreateData¶

{
  // Required
  endTimestamp : timestamp
  policyLocator : string
  policyModificationLocator : string
  renewalLocator : string
  startTimestamp : timestamp
}

EventStreamRenewalUpdateData¶

{
  // Required
  endTimestamp : timestamp
  policyLocator : string
  policyModificationLocator : string
  renewalLocator : string
  startTimestamp : timestamp
}

EventStreamRenewalAcceptData¶

{
  // Required
  endTimestamp : timestamp
  policyLocator : string
  policyModificationLocator : string
  renewalLocator : string
  startTimestamp : timestamp
}

EventStreamRenewalIssueData¶

{
  // Required
  endTimestamp : timestamp
  policyLocator : string
  policyModificationLocator : string
  renewalLocator : string
  startTimestamp : timestamp
}

EventStreamRenewalData¶

{
  // Required
  endTimestamp : timestamp
  modificationLocator : string
  policyLocator : string
  startTimestamp : timestamp
}

EventStreamCancellationCreateData¶

{
  // Required
  cancellationLocator : string
  modificationName : string
  policyLocator : string
}

EventStreamCancellationUpdateData¶

{
  // Required
  cancellationLocator : string
  modificationName : string
  policyLocator : string
}

EventStreamCancellationRescindData¶

{
  // Required
  cancellationLocator : string
  modificationName : string
  policyLocator : string
}

EventStreamCancellationIssueData¶

{
  // Required
  cancellationLocator : string
  modificationName : string
  policyLocator : string
}

EventStreamReinstatementCreateData¶

{
  // Required
  cancellationLocator : string
  policyLocator : string
  reinstatementLocator : string
}

EventStreamReinstatementAcceptData¶

{
  // Required
  cancellationLocator : string
  policyLocator : string
  reinstatementLocator : string
}

EventStreamReinstatementIssueData¶

{
  // Required
  policyLocator : string
  reinstatementLocator : string

  // Optional
  cancellationLocator : string
}

EventStreamReinstatementInvalidateData¶

{
  // Required
  cancellationLocator : string
  policyLocator : string
  reinstatementLocator : string
}

EventStreamReinstatementDeadlineReachedData¶

{
  // Required
  cancellationLocator : string
  policyLocator : string
  reinstatementLocator : string
}

EventStreamPremiumReportCreateData¶

{
  // Required
  premiumReportLocator : string
}

EventStreamPremiumReportUpdateData¶

{
  // Required
  premiumReportLocator : string
}

EventStreamPremiumReportIssueData¶

{
  // Required
  premiumReportLocator : string
}

EventStreamPremiumReportDiscardData¶

{
  // Required
  premiumReportLocator : string
}

Name	Position	Type	Required
endTimestamp	query	integer	optional
eventType	query	string	optional
pageSize	query	integer	optional
pagingToken	query	string	optional
startTimestamp	query	integer	optional

Name	Position	Type	Required
endTimestamp	query	integer	optional
eventType	query	string	optional
pageSize	query	integer	optional
pagingToken	query	string	optional
startTimestamp	query	integer	optional