Event Stream API

Note

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

Endpoint Index

Action	Endpoint
Fetch events	GET /eventstream/events
Fetch attributed events	GET /eventstream/attributedEvents

Details

Fetch events¶

GET /eventstream/events

Request:

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

Response: EventPageResponse

Fetch attributed events¶

GET /eventstream/attributedEvents

Request:

Name	Position	Type	Required
endTimestamp	query	timestamp	optional
eventType	query	string	optional
pageSize	query	integer	optional
pagingToken	query	string	optional
startTimestamp	query	timestamp	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

EventResponse¶

required
id string
timestamp timestamp
data EventStreamData
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 | invoice.invalidate | invoice.pastDue | invoice.writtenOff | payment.pay | policy.cancel | policy.create | policy.discard | policy.endorse | policy.finalize | policy.issue | policy.lapse | policy.reinstatement.close | policy.reinstatement.invoice | policy.reinstatement.issue | policy.reinstatement.open | policy.renew | policy.update | policy.upgrade | 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 | policy.quote.invalidate | premiumReport.create | premiumReport.update | premiumReport.issue | premiumReport.discard | premiumReport.reverse | premiumReport.replace | login.success | login.failure | policyholder.create | policyholder.update | payment.reverse | policy.gracePeriod.satisfied | webhook.suspended

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.gracePeriod: EventStreamGracePeriodCreateData
policy.gracePeriod.update: EventStreamGracePeriodUpdateData
policy.gracePeriod.satisfied: EventStreamGracePeriodSatisfiedData
policy.upgrade: EventStreamPolicyUpgradeData
policy.end.reminder: EventStreamPolicyEndReminderData
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.invalidate: EventStreamPolicyQuoteInvalidateData
policy.quote.discard: EventStreamPolicyQuoteDiscardData

Endorsements

endorsement.create: EventStreamEndorsementCreateData
endorsement.update: EventStreamEndorsementUpdateData
endorsement.quote : EventStreamEndorsementQuoteData
endorsement.accept: EventStreamEndorsementAcceptData
endorsement.issue: EventStreamEndorsementIssueData
endorsement.invalidate: EventStreamEndorsementInvalidateData
endorsement.discard: EventStreamEndorsementDiscardData
policy.endorse: EventStreamPolicyEndorseData (Legacy)

Renewals

renewal.create: EventStreamRenewalCreateData
renewal.update: EventStreamRenewalUpdateData
renewal.quote: EventStreamRenewalQuoteData
renewal.accept: EventStreamRenewalAcceptData
renewal.issue: EventStreamRenewalIssueData
renewal.invalidate: EventStreamRenewalInvalidateData
renewal.discard: EventStreamRenewalDiscardData
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
invoice.invalidate: EventStreamPolicyInvoiceInvalidateData
invoice.pastDue: EventStreamPolicyInvoicePastDueData
invoice.writtenOff: EventStreamPolicyInvoiceWrittenOffData
payment.pay: EventStreamPaymentPayData
payment.reverse: EventStreamPaymentReverseData

Premium Reports

premiumReport.create: EventStreamPremiumReportCreateData
premiumReport.update: EventStreamPremiumReportUpdateData
premiumReport.issue: EventStreamPremiumReportIssueData
premiumReport.discard: EventStreamPremiumReportDiscardData
premiumReport.reverse: EventStreamPremiumReportReverseData
premiumReport.replace: EventStreamPremiumReportReplaceData

Webhooks

webhook.suspended: EventStreamWebhookSuspendedData

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
policyLocator string
modificationName string
effectiveDate integer (deprecated)

optional
effectiveTimestamp timestamp

EventStreamPolicyEndData¶

required
policyLocator string
policyEndTimestamp timestamp

EventStreamPolicyDiscardData¶

required
policyLocator string

EventStreamGracePeriodCreateData¶

required
policyLocator string
gracePeriodLocator string

EventStreamGracePeriodUpdateData¶

required
policyLocator string
gracePeriodLocator string

optional
cancelEffectiveTimestamp timestamp
newEndTimestamp timestamp
previousEndTimestamp timestamp

EventStreamGracePeriodSatisfiedData¶

required
policyLocator string
settledTimestamp timestamp
gracePeriodLocator string

EventStreamPolicyUpgradeData¶

required
policyLocator string
newConfigVersion integer
originalConfigVersion integer

EventStreamPolicyEndReminderData¶

required
policyLocator string
policyEndTimestamp timestamp
reminderName string

EventStreamPolicyLapseData¶

required
policyLocator string
lapseLocator string

EventStreamReinstatementOpenData¶

required
policyLocator string
reinstatementLocator string

EventStreamReinstatementInvoiceData¶

required
policyLocator string
invoiceLocator 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

EventStreamPolicyQuoteInvalidateData¶

required
policyLocator string
quoteLocator string

EventStreamPolicyQuoteDiscardData¶

required
policyLocator string
quoteLocator string

EventStreamClaimCloseData¶

required
policyLocator string
claimLocator string

EventStreamClaimCreateData¶

required
policyLocator string
claimLocator string

EventStreamClaimDiscardData¶

required
policyLocator string
claimLocator string

EventStreamClaimOpenData¶

required
policyLocator string
claimLocator string

EventStreamClaimUpdateData¶

required
policyLocator string
claimLocator string

EventStreamSubClaimOpenData¶

required
policyLocator string
claimLocator string
subClaimLocator string

EventStreamSubClaimUpdateData¶

required
policyLocator string
claimLocator string
subClaimLocator string

EventStreamSubClaimCloseData¶

required
policyLocator string
claimLocator string
subClaimLocator string

EventStreamSubClaimReOpenData¶

required
policyLocator string
claimLocator string
subClaimLocator string

EventStreamSubClaimReserveUpdateData¶

required
policyLocator string
claimLocator string
reserveCurrency string
reserveType string loss | expense
subClaimLocator string

optional
newAmount number
oldAmount number

EventStreamSubClaimPayableCreateData¶

required
policyLocator string
claimLocator string
payableLocator string
subClaimLocator string

optional
amountChange number
reserveCurrency string
reserveType string loss | expense

EventStreamSubClaimPayableReverseData¶

required
policyLocator string
claimLocator string
reversalLocator string
reversedLocator string
subClaimLocator string

optional
amountChange number
reserveCurrency string
reserveType string loss | expense

EventStreamPaymentPayData¶

required
policyLocator string
invoiceLocator string
paymentLocator string

EventStreamPaymentReverseData¶

required
policyLocator string
invoiceLocator string
paymentLocator string

EventStreamPolicyInvoiceIssueData¶

required
policyLocator string
invoiceLocator string

EventStreamPolicyInvoiceInvalidateData¶

required
policyLocator string
invoiceLocator string

EventStreamPolicyInvoicePastDueData¶

required
policyLocator string
invoiceLocator string

EventStreamPolicyInvoiceWrittenOffData¶

required
policyLocator string
invoiceLocator string

EventStreamEndorsementCreateData¶

required
policyLocator string
endorsementName string
endorsementLocator string
policyModificationLocator string

EventStreamEndorsementUpdateData¶

required
policyLocator string
endorsementName string
endorsementLocator string
policyModificationLocator string

EventStreamEndorsementQuoteData¶

required
policyLocator string
endorsementName string
endorsementLocator string
policyModificationLocator string

EventStreamEndorsementAcceptData¶

required
policyLocator string
endorsementName string
endorsementLocator string
policyModificationLocator string

EventStreamEndorsementIssueData¶

required
policyLocator string
endorsementName string
endorsementLocator string
policyModificationLocator string

EventStreamEndorsementInvalidateData¶

required
policyLocator string
endorsementLocator string

EventStreamEndorsementDiscardData¶

required
policyLocator string
endorsementLocator string

EventStreamPolicyEndorseData¶

required
policyLocator string
endorsementName string
modificationLocator string

EventStreamRenewalCreateData¶

required
policyLocator string
startTimestamp timestamp
endTimestamp timestamp
policyModificationLocator string
renewalLocator string

EventStreamRenewalUpdateData¶

required
policyLocator string
startTimestamp timestamp
endTimestamp timestamp
policyModificationLocator string
renewalLocator string

EventStreamRenewalAcceptData¶

required
policyLocator string
startTimestamp timestamp
endTimestamp timestamp
policyModificationLocator string
renewalLocator string

EventStreamRenewalQuoteData¶

required
policyLocator string
startTimestamp timestamp
endTimestamp timestamp
policyModificationLocator string
renewalLocator string

EventStreamRenewalIssueData¶

required
policyLocator string
startTimestamp timestamp
endTimestamp timestamp
policyModificationLocator string
renewalLocator string

EventStreamRenewalInvalidateData¶

required
policyLocator string
renewalLocator string

EventStreamRenewalDiscardData¶

required
policyLocator string
renewalLocator string

EventStreamRenewalData¶

required
policyLocator string
startTimestamp timestamp
endTimestamp timestamp
modificationLocator string

EventStreamCancellationCreateData¶

required
policyLocator string
cancellationLocator string
modificationName string
effectiveDate integer (deprecated)

optional
effectiveTimestamp timestamp

EventStreamCancellationUpdateData¶

required
policyLocator string
cancellationLocator string
modificationName string
effectiveDate integer (deprecated)

optional
effectiveTimestamp timestamp

EventStreamCancellationRescindData¶

required
policyLocator string
cancellationLocator string
modificationName string
effectiveDate integer (deprecated)

optional
effectiveTimestamp timestamp

EventStreamCancellationIssueData¶

required
policyLocator string
cancellationLocator string
modificationName string
effectiveDate integer (deprecated)

optional
effectiveTimestamp timestamp
cancellationName string

EventStreamReinstatementCreateData¶

required
policyLocator string
cancellationLocator string
reinstatementLocator string

EventStreamReinstatementAcceptData¶

required
policyLocator string
cancellationLocator string
reinstatementLocator string

EventStreamReinstatementIssueData¶

required
policyLocator string
reinstatementLocator string

optional
cancellationLocator string

EventStreamReinstatementInvalidateData¶

required
policyLocator string
cancellationLocator string
reinstatementLocator string

EventStreamReinstatementDeadlineReachedData¶

required
policyLocator string
cancellationLocator string
reinstatementLocator string

EventStreamPremiumReportCreateData¶

required
policyLocator string
premiumReportLocator string

EventStreamPremiumReportUpdateData¶

required
policyLocator string
premiumReportLocator string

EventStreamPremiumReportIssueData¶

required
policyLocator string
premiumReportLocator string

EventStreamPremiumReportDiscardData¶

required
policyLocator string
premiumReportLocator string

EventStreamPremiumReportReplaceData¶

required
policyLocator string
newPremiumReportLocator string
replacedPremiumReportLocator string

EventStreamPremiumReportReverseData¶

required
policyLocator string
premiumReportLocator string

EventStreamWebhookSuspendedData¶

required
event 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 | invoice.invalidate | invoice.pastDue | invoice.writtenOff | payment.pay | policy.cancel | policy.create | policy.discard | policy.endorse | policy.finalize | policy.issue | policy.lapse | policy.reinstatement.close | policy.reinstatement.invoice | policy.reinstatement.issue | policy.reinstatement.open | policy.renew | policy.update | policy.upgrade | 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 | policy.quote.invalidate | premiumReport.create | premiumReport.update | premiumReport.issue | premiumReport.discard | premiumReport.reverse | premiumReport.replace | login.success | login.failure | policyholder.create | policyholder.update | payment.reverse | policy.gracePeriod.satisfied
integrationName string
webhookName string