Webhooks API

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

Endpoint Index

Action	Endpoint
Create or Update a Webhook	PUT /webhooks
Get all Webhooks	GET /webhooks
Get a Webhook	GET /webhooks/{name}
Delete a Webhook	DELETE /webhooks/{name}
Enable a suspended Webhook	PATCH /webhooks/{name}/unsuspend
Get a paginated list of diverted events	GET /webhooks/{name}/diverted
Delete a diverted event	DELETE /webhooks/{name}/diverted/{transactionId}
Resend a diverted event	POST /webhooks/{name}/diverted/{transactionId}/resend

Details

Create or Update a Webhook¶

PUT /webhooks

Request:

Name	Position	Type	Required
request	body	WebhookRequest	required

Response: WebhookResponse

Get all Webhooks¶

GET /webhooks

Response: WebhooksResponse

Get a Webhook¶

GET /webhooks/{name}

Request:

Name	Position	Type	Required
name	path	string	required

Response: WebhookResponse

Delete a Webhook¶

DELETE /webhooks/{name}

Request:

Name	Position	Type	Required
name	path	string	required

Response: void

Enable a suspended Webhook¶

PATCH /webhooks/{name}/unsuspend

Request:

Name	Position	Type	Required
name	path	string	required

Response: WebhookResponse

Get a paginated list of diverted events¶

GET /webhooks/{name}/diverted

Request:

Name	Position	Type	Required
limit	query	integer	optional
name	path	string	required
offset	query	integer	optional

Response: WebhookDivertedEventsResponse

Delete a diverted event¶

DELETE /webhooks/{name}/diverted/{transactionId}

Request:

Name	Position	Type	Required
name	path	string	required
transactionId	path	string	required

Response: void

Resend a diverted event¶

POST /webhooks/{name}/diverted/{transactionId}/resend

Request:

Name	Position	Type	Required
name	path	string	required
transactionId	path	string	required

Response: void

WebhookRequest¶

required
name string

optional
alertIntegrationName string
displayName string
enabled boolean
events [string cancellation.create | cancellation.update | cancellation.rescind | cancellation.issue | cancellation.effective | 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 | endorsement.effective | reinstatement.accept | reinstatement.create | reinstatement.issue | reinstatement.invalidate | reinstatement.deadlineReached | reinstatement.effective | renewal.create | renewal.update | renewal.quote | renewal.accept | renewal.issue | renewal.invalidate | renewal.discard | renewal.effective | policy.effective | 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 | premiumReport.effective | premiumReport.pay | login.success | login.failure | policyholder.create | policyholder.update | payment.reverse | payment.update | payment.ready | payment.discard | payment.return | payment.decline | payment.draft | policy.gracePeriod.satisfied | disbursement.issue | disbursement.create | disbursement.update | catchUp.issue | catchUp.writtenOff | catchUp.pay | catchUp.pay.reverse | catchUp.invalidate | catchUp.pastDue | cash.transfer]
failureHandling FailureHandlingRequest
integrationName string
resetAlertIntegrationName boolean
retryStrategy string none | one | three

WebhookResponse¶

required
name string
enabled boolean
events [string cancellation.create | cancellation.update | cancellation.rescind | cancellation.issue | cancellation.effective | 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 | endorsement.effective | reinstatement.accept | reinstatement.create | reinstatement.issue | reinstatement.invalidate | reinstatement.deadlineReached | reinstatement.effective | renewal.create | renewal.update | renewal.quote | renewal.accept | renewal.issue | renewal.invalidate | renewal.discard | renewal.effective | policy.effective | 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 | premiumReport.effective | premiumReport.pay | login.success | login.failure | policyholder.create | policyholder.update | payment.reverse | payment.update | payment.ready | payment.discard | payment.return | payment.decline | payment.draft | policy.gracePeriod.satisfied | disbursement.issue | disbursement.create | disbursement.update | catchUp.issue | catchUp.writtenOff | catchUp.pay | catchUp.pay.reverse | catchUp.invalidate | catchUp.pastDue | cash.transfer]
failureHandling FailureHandlingResponse
integrationName string
retryStrategy string none | one | three
suspended boolean

optional
suspendedTimestamp timestamp
alertIntegrationName string
displayName string

WebhooksResponse¶

required
webhooks [WebhookResponse]

WebhookPayload¶

required
id string
timestamp timestamp
data EventStreamData
transactionId string
type string
username string

FailureMessage¶

required
actualStatus string
eventData EventStreamData
expectedStatus string
url string
webhookName object

FailureHandlingRequest¶

optional
actOnStatusCodes [string]
actOnTimeout boolean
mode string none | divert | suspend

FailureHandlingResponse¶

required
actOnStatusCodes [string]
actOnTimeout boolean
mode string none | divert | suspend

EventStreamWebhookSuspendedData¶

required
event string cancellation.create | cancellation.update | cancellation.rescind | cancellation.issue | cancellation.effective | 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 | endorsement.effective | reinstatement.accept | reinstatement.create | reinstatement.issue | reinstatement.invalidate | reinstatement.deadlineReached | reinstatement.effective | renewal.create | renewal.update | renewal.quote | renewal.accept | renewal.issue | renewal.invalidate | renewal.discard | renewal.effective | policy.effective | 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 | premiumReport.effective | premiumReport.pay | login.success | login.failure | policyholder.create | policyholder.update | payment.reverse | payment.update | payment.ready | payment.discard | payment.return | payment.decline | payment.draft | policy.gracePeriod.satisfied | disbursement.issue | disbursement.create | disbursement.update | catchUp.issue | catchUp.writtenOff | catchUp.pay | catchUp.pay.reverse | catchUp.invalidate | catchUp.pastDue | cash.transfer
integrationName string
webhookName string

WebhookDivertedEventsResponse¶

required
events [WebhookDivertedEventResponse]
webhookName string

WebhookDivertedEventResponse¶

required
eventType string cancellation.create | cancellation.update | cancellation.rescind | cancellation.issue | cancellation.effective | 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 | endorsement.effective | reinstatement.accept | reinstatement.create | reinstatement.issue | reinstatement.invalidate | reinstatement.deadlineReached | reinstatement.effective | renewal.create | renewal.update | renewal.quote | renewal.accept | renewal.issue | renewal.invalidate | renewal.discard | renewal.effective | policy.effective | 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 | premiumReport.effective | premiumReport.pay | login.success | login.failure | policyholder.create | policyholder.update | payment.reverse | payment.update | payment.ready | payment.discard | payment.return | payment.decline | payment.draft | policy.gracePeriod.satisfied | disbursement.issue | disbursement.create | disbursement.update | catchUp.issue | catchUp.writtenOff | catchUp.pay | catchUp.pay.reverse | catchUp.invalidate | catchUp.pastDue | cash.transfer
timestamp timestamp
data EventStreamData
eventId string
transactionId string

optional
username string