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 include a pagingToken if there are more events beyond those returned on the returned set. For subsequent calls to fetch more events, include the pagingToken but omit the original filter criteria.

EventResponse

{
  // Required
  "data" : EventStreamData
  "id" : string
  "timestamp" : integer
  "type" : string cancellation.draft | cancellation.update | cancellation.rescind | cancellation.issue | claim.close | claim.create | claim.discard | claim.open | claim.update | policy.gracePeriod | 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

  // Optional
  "username" : string
}

EventStreamData

{
no fields
}

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

Login

Policies

Quotes

Endorsements

Renewals

Invoicing and Payments

Premium Reports

EventStreamLoginData

{
  // Required
  "username" : string
}

EventStreamLoginFailureData

{
  // Required
  "username" : string
}

EventStreamPolicyCreateData

{
  // Required
  "policyLocator" : string
}

EventStreamPolicyUpdateData

{
  // Required
  "policyLocator" : string
}

EventStreamPolicyFinalizeData

{
  // Required
  "policyLocator" : string
}

EventStreamPolicyIssueData

{
  // Required
  "policyLocator" : string
}

EventStreamPolicyCancelData

{
  // Required
  "effectiveDate" : integer
  "modificationName" : string
  "policyLocator" : string
}

EventStreamPolicyEndData

{
  // Required
  "policyEndTimestamp" : integer
  "policyLocator" : string
}

EventStreamPolicyDiscardData

{
  // Required
  "policyLocator" : string
}

EventStreamGracePeriodCreateData

{
  // Required
  "gracePeriodLocator" : string
  "policyLocator" : string
}

EventStreamPolicyLapseData

{
  // Required
  "lapseLocator" : string
  "policyLocator" : string
}

EventStreamReinstatementOpenData

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

EventStreamReinstatementInvoiceData

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

EventStreamReinstatementIssueData

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

EventStreamReinstatementCloseData

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

EventStreamPolicyEndReminderData

{
  // Required
  "policyEndTimestamp" : integer
  "policyLocator" : string
  "reminderName" : 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
}

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" : integer
  "policyLocator" : string
  "policyModificationLocator" : string
  "renewalLocator" : string
  "startTimestamp" : integer
}

EventStreamRenewalUpdateData

{
  // Required
  "endTimestamp" : integer
  "policyLocator" : string
  "policyModificationLocator" : string
  "renewalLocator" : string
  "startTimestamp" : integer
}

EventStreamRenewalAcceptData

{
  // Required
  "endTimestamp" : integer
  "policyLocator" : string
  "policyModificationLocator" : string
  "renewalLocator" : string
  "startTimestamp" : integer
}

EventStreamRenewalIssueData

{
  // Required
  "endTimestamp" : integer
  "policyLocator" : string
  "policyModificationLocator" : string
  "renewalLocator" : string
  "startTimestamp" : integer
}

EventStreamRenewalData

{
  // Required
  "endTimestamp" : integer
  "modificationLocator" : string
  "policyLocator" : string
  "startTimestamp" : integer
}

EventStreamPremiumReportCreateData

{
  // Required
  "premiumReportLocator" : string
}

EventStreamPremiumReportUpdateData

{
  // Required
  "premiumReportLocator" : string
}

EventStreamPremiumReportIssueData

{
  // Required
  "premiumReportLocator" : string
}

EventStreamPremiumReportDiscardData

{
  // Required
  "premiumReportLocator" : string
}