Overview
Events are shared across many parts of the Root platform as a record of actions performed against policies and other entities. This page documents examples of many of the event types we store.
Note that only a subset of these events are available as webhook subscriptions. Please see the webhooks page for more details.
Also note that events are not available via bulk data exports.
Application events
application_used
application_used
Indicated that an existing application was used.
{
"event": {
"type": "application_used",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"metadata": {
"requested_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
}
application_created
application_created
Indicates that a new application was created.
{
"event": {
"type": "application_created",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"metadata": {
"requested_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
},
"policyholder_id": "bf3ab7ce-064d-43b7-811d-0ecd9aca3daf",
"package_name": "Theft + comprehensive",
"sum_assured": 1199900,
"monthly_premium": 50000,
"base_premium": 14999,
"module": {
"type": "root_gadgets",
"make": "Apple",
"model": "iPhone 6S 64GB LTE",
"serial_number": "1234567890"
},
"currency": "ZAR"
}
}
Call events
connect_called_busy
connect_called_busy
Indicates that a connect call was initiated but a busy signal was received.
{
"event": {
"type": "connect_called_busy",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
connect_call_not_answered
connect_call_not_answered
Indicates that a connect call was not answered.
{
"event": {
"type": "connect_call_not_answered",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
connect_call_completed
connect_call_completed
Indicates that a connect call was completed.
{
"event": {
"type": "connect_call_completed",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
connect_call_answered
connect_call_answered
Indicates that a connect call was answered.
{
"event": {
"type": "connect_call_answered",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
connect_call_ringing
connect_call_ringing
Indicates that a connect all is ringing.
{
"event": {
"type": "connect_call_ringing",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
connect_call_initiated
connect_call_initiated
Indicates that a connect call was initiated.
{
"event": {
"type": "connect_call_initiated",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
call_flushed
call_flushed
Indicates that a call was flushed.
{
"event": {
"type": "call_flushed",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
called_busy
called_busy
Indicates that a call was initiated but a busy signal was received.
{
"event": {
"type": "called_busy",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
call_not_answered
call_not_answered
Indicates that a call was not answered.
{
"event": {
"type": "call_not_answered",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
call_completed
call_completed
Indicates that a call was completed.
{
"event": {
"type": "call_completed",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
call_answered
call_answered
Indicates that a call has been answered.
{
"event": {
"type": "call_answered",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
call_ringing
call_ringing
Indicates that a call is ringing.
{
"event": {
"type": "call_ringing",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
call_initiated
call_initiated
Indicates that a call was initiated.
{
"event": {
"type": "call_initiated",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
recording_added
recording_added
Indicates that a new recording was added.
{
"event": {
"type": "recording_added",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"recording_url": "https://recordingurl.com"
}
}
option_entered
option_entered
Indicates that a new option was entered.
{
"event": {
"type": "option_entered",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"option": "3"
}
}
outbound_call_started
outbound_call_started
Indicates that an outbound call was started.
{
"event": {
"type": "outbound_call_started",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"from": "27823378000",
"to": "27760008733"
}
}
inbound_call_started
inbound_call_started
Indicates that an inbound call was started.
{
"event": {
"type": "inbound_call_started",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"from": "27823378000"
}
}
Claim events
claim_checklist_item_note_created
claim_checklist_item_note_created
Indicates that a claim checklist item had a note created for it.
{
"event": {
"type": "claim_checklist_item_note_created",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
claim_checklist_item_checked
claim_checklist_item_checked
Indicates that a claim checklist item was checked.
{
"event": {
"type": "claim_checklist_item_checked",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"checked": true
}
}
claim_goodwill_not_acknowledged
claim_goodwill_not_acknowledged
Indicates that a claim goodwill was not acknowledged.
{
"event": {
"type": "claim_goodwill_not_acknowledged",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
claim_goodwill_acknowledged
claim_goodwill_acknowledged
Indicates that a claim goodwill was acknowledged.
{
"event": {
"type": "claim_goodwill_acknowledged",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
claim_goodwill
claim_goodwill
Indicates that a claim has goodwill.
{
"event": {
"type": "claim_goodwill",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
claim_no_claim_not_acknowledge
claim_no_claim_not_acknowledge
Indicates that a claim no claim was not acknowledged.
{
"event": {
"type": "claim_no_claim_not_acknowledged",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"reason": "Some reason here"
}
}
claim_no_claim_acknowledged
claim_no_claim_acknowledged
Indicates that a claim no claim was acknowledged.
{
"event": {
"type": "claim_no_claim_acknowledged",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
claim_no_claim
claim_no_claim
Indicates that a claim was awarded no claim.
{
"event": {
"type": "claim_no_claim",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
claim_repudiation_not_acknowledged
claim_repudiation_not_acknowledged
Indicates that a claim repudiation was not acknowledged.
{
"event": {
"type": "claim_repudiation_not_acknowledged",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
claim_repudiation_acknowledged
claim_repudiation_acknowledged
Indicates that a claim repudiation was acknowledged.
{
"event": {
"type": "claim_repudiation_acknowledged",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
claim_repudiated
claim_repudiated
Indicates that a claim was repudiated.
{
"event": {
"reason": "Reason for claim repudiation",
"type": "claim_repudiated",
"claim_id": "42211328-5b8e-4248-813b-c44523822e5e",
"created_at": "2017-05-25T14:23:35.265Z",
"requested_by": {
"type": "user",
"id": "00000000-0000-0000-0000-000000000001"
}
}
}
claim_approval_not_acknowledged
claim_approval_not_acknowledged
Indicates that a claim approval was not acknowledged.
{
"event": {
"type": "claim_approval_not_acknowledged",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
claim_approval_acknowledged
claim_approval_acknowledged
Indicates that a claim approval has been acknowledged.
{
"event": {
"type": "claim_approval_acknowledged",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
claim_approved
claim_approved
Indicates that a claim has been approved.
{
"event": {
"reason": "Valid approval reason",
"type": "claim_approved",
"claim_id": "14dbf7d3-de87-4296-8240-fdc633fea979",
"created_at": "2017-05-25T14:15:53.696Z",
"requested_by": {
"type": "user",
"id": "00000000-0000-0000-0000-000000000001"
}
}
}
attachment_created
attachment_created
Indicates that an attachment has been created.
{
"event": {
"type": "attachment_created",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"file_name": "attachment",
"file_type": "txt",
"file_url": "http://someurl.com/attachment.txt",
"description": "Some description here"
}
}
text_note_created
text_note_created
Indicates that a text note has been created.
{
"event": {
"type": "text_note_created",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"text": "text goes here"
}
}
claim_payout_paid
claim_payout_paid
Indicates that a claim payout has been paid.
{
"event": {
"payout": {},
"type": "claim_payout_paid",
"claim_id": "14dbf7d3-de87-4296-8240-fdc633fea979",
"created_at": "2017-05-25T14:18:34.554Z",
"requested_by": {
"type": "user",
"id": "00000000-0000-0000-0000-000000000001"
}
}
}
claim_payout_requested
claim_payout_requested
Indicates that a claim payout has been requested.
[
{
"claim_id": "d3d13c48-4dc3-4816-8d01-de3215878225",
"claim_number": "D2F69D1CA322",
"created_at": "2021-05-21T08:14:42.034Z",
"claim_status": "pending_payout",
"claimant": {
"first_name": "Erlich",
"last_name": "Bachman",
"email": "[email protected]",
"relationship": "main_member"
},
"approval_status": "approved",
"policy_id": "128ba0c0-3f6a-4f8b-9b40-e2066b02b59e",
"policyholder_id": "c36b5448-643b-4aad-8932-34904b2da3d9",
"incident_type": null,
"incident_cause": null,
"app_data": null,
"module_data": {
"key": "value"
},
"requested_amount": 2621800,
"rejection_reason": null,
"created_by": {
"type": "user",
"id": "00000000-0000-0000-0000-000000000001"
},
"currency": "ZAR",
"block_states": {
"checkbox_block": {
"type": "checkbox"
},
"currency_amount": {
"type": "input.currency"
},
"free_text_block": {
"type": "input.text"
}
},
"updated_at": "2021-05-21T08:15:42.437Z"
}
]
policy_linked
policy_linked
Indicates that a policy has been linked.
{
"event": {
"type": "policy_linked",
"claim_id": "d7bb3129-b56e-4dd2-a712-b19a225fba6d",
"created_at": "2017-05-25T14:20:21.201Z",
"requested_by": {
"type": "user",
"id": "00000000-0000-0000-0000-000000000001"
}
}
}
claimant_updated
claimant_updated
Indicates that a claimant was updated.
{
"event": {
"type": "claimant_updated",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"claimant": {
"first_name": "Erlich",
"last_name": "Bachman",
"id_number": "6801015800084",
"cellphone": "0821234567",
"email": "[email protected]",
"relationship": "spouse"
}
}
}
claim_updated
claim_updated
Indicates that a claim was updated.
{
"event": {
"type": "claim_updated",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"incident_type": "accident",
"incident_cause": "negligence",
"incident_date": "2017-09-25T18:28:30+02:00",
"requested_amount": "2000000"
}
}
claim_sent_to_review
claim_sent_to_review
Indicates that a claim has been sent to review.
{
"event": {
"type": "claim_sent_to_review",
"claim_id": "14dbf7d3-de87-4296-8240-fdc633fea979",
"created_at": "2017-05-25T14:15:02.892Z",
"requested_by": {
"type": "user",
"id": "00000000-0000-0000-0000-000000000001"
}
}
}
claim_reopened
claim_reopened
Indicates that a claim was reopened.
{
"event": {
"type": "claim_reopened",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"reason": "Reason for claim being reopened"
}
}
claim_flushed
claim_flushed
Indicates that a claim was flushed.
{
"event": {
"type": "claim_flushed",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
claim_closed
claim_closed
Indicates that a claim was closed.
{
"event": {
"type": "claim_closed",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
claim_opened
claim_opened
Indicates that a claim was opened.
{
"event": {
"type": "claim_opened",
"claim_id": "14dbf7d3-de87-4296-8240-fdc633fea979",
"created_at": "2017-05-25T14:13:00.467Z",
"requested_by": {
"type": "user",
"id": "00000000-0000-0000-0000-000000000001"
}
}
}
Complaint events
attachment_created
attachment_created
Indicates that an attachment was created.
{
"event": {
"type": "attachment_created",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"file_name": "attachment",
"file_type": "txt",
"file_url": "http://someurl.com/attchment.txt",
"description": "Some description here"
}
}
text_note_created
text_note_created
Indicates that a text note was created.
{
"event": {
"type": "text_note_created",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"text": "Some text here"
}
}
policy_linked
policy_linked
Indicates that a policy was linked.
{
"event": {
"type": "policy_linked",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"policy_id": "00f071ac-c312-42e9-b018-b4305b560381",
"member_id": "eb7b747a-7305-11e7-94d6-e325c1247a46e",
"policyholder_id": "b018c124-7305-11e7-94d6-c3b7b747a46e"
}
}
complainant_updated
complainant_updated
Indicates that a complainant was updated.
{
"event": {
"type": "complainant_updated",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"complainant": {
"first_name": "Erlich",
"last_name": "Bachman",
"email": "[email protected]",
"cellphone": "0821234567",
"id_number": "8302070043076"
}
}
}
complaint_updated
complaint_updated
Indicates that a complaint was updated.
{
"event": {
"type": "complaint_updated",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"incident_type": "accident",
"incident_cause": "negligence",
"incident_date": "2017-08-01T18:28:30+02:00",
"requested_amount": 23000
}
}
complaint_reopened
complaint_reopened
Indicates that a complaint was reopened.
{
"event": {
"type": "complaint_reopened",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"reason": "Some reason here"
}
}
complaint_flushed
complaint_flushed
Indicates that a complaint was flushed.
{
"event": {
"type": "complaint_flushed",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
complaint_closed
complaint_closed
Indicates that a complaint was closed.
{
"event": {
"type": "complaint_closed",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
complaint_opened
complaint_opened
Indicates that a complaint was opened.
{
"event": {
"type": "complaint_opened",
"complaint_id": "f7900c30-727c-44ef-b5fb-5142d7f1c503",
"created_at": "2017-05-25T14:12:03.014Z",
"incident_type": "accident",
"incident_cause": "negligence",
"incident_date": "2017-03-01T18:28:30+02:00",
"requested_amount": 23000,
"requested_by": {
"type": "user",
"id": "00000000-0000-0000-0000-000000000001"
}
}
}
Payment updates events
payment_updates_failed
payment_updates_failed
Indicates that an attempt to update payments async failed.
{
"event": {
"type": "payment_updates_failed",
"payment_ids": [
"f7261eb1-b17b-4291-92b8-861b34d899ff",
"31c3c3c6-d912-4481-98d1-1b4a5b2a0eec"
],
"error": "Payment f7261eb1-b17b-4291-92b8-861b34d899ff status is successful and cannot be changed",
"created_at": "2022-08-10T10:33:45.653Z",
"requested_by": {
"type": "api_key",
"id": "d1d9254e-491c-468d-aa26-969cfb2a7db4",
"owner_id": "00000000-0000-0000-0000-000000000001"
}
}
}
payment_updates_succeeded
payment_updates_succeeded
Indicates that an attempt to update payments async succeeded.
{
"event": {
"type": "payment_updates_succeeded",
"payment_ids": [
"f7261eb1-b17b-4291-92b8-861b34d899ff",
"31c3c3c6-d912-4481-98d1-1b4a5b2a0eec"
],
"created_at": "2022-08-10T10:34:42.960Z",
"requested_by": {
"type": "api_key",
"id": "d1d9254e-491c-468d-aa26-969cfb2a7db4",
"owner_id": "00000000-0000-0000-0000-000000000001"
}
}
}
Policy events
complaint_linked
complaint_linked
Indicates that a complaint has been linked.
{
"event": {
"type": "complaint_linked",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"complaint_id": "263a9c1e-aa41-4380-8fc8-0b03a1d9c0e8"
}
}
claim_linked
claim_linked
Indicates that a claim has been linked.
{
"event": {
"type": "claim_linked",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"claim_id": "f48393b2-1e7e-4a48-9254-b468e1b68d80"
}
}
attachment_created
attachment_created
Indicates that an attachment was created.
{
"event": {
"type": "attachment_created",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"file_name": "attachment",
"file_type": "txt",
"file_url": "http://someurl.com/attachment.txt",
"description": "Some description here"
}
}
text_note_created
text_note_created
Indicates that a text note was created.
{
"event": {
"type": "text_note_created",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"text": "Some text here"
}
}
policy_flushed
policy_flushed
Indicates that a policy was flushed.
{
"event": {
"type": "policy_flushed",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
payment_method_assigned
payment_method_assigned
Indicates that a payment method was assigned to a policy.
{
"event": {
"type": "payment_method_assigned",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
payment_method_added_event
payment_method_added_event
Indicates that a payment method was added.
{
"event": {
"type": "payment_method_added_event",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
policy_members_updated
policy_members_updated
Indicates that the members of a policy was updated.
{
"event": {
"type": "policy_members_updated",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"monthly_premium": 3400
}
}
beneficiary_updated
beneficiary_updated
Indicates that a beneficiary for a policy was updated.
{
"event": {
"type": "beneficiary_updated",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
policy_beneficiaries_updated
policy_beneficiaries_updated
Indicates that the beneficiaries for a policy was updated.
{
"event": {
"type": "policy_beneficiaries_updated",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"alteration": "beneficiaries_updated"
}
}
policy_receipt_created
policy_receipt_created
Indicates that a policy receipt was created.
{
"event": {
"type": "policy_receipt_created",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
policy_sum_assured_updated
policy_sum_assured_updated
Indicates that the sum assured for a policy was updated.
{
"event": {
"type": "policy_sum_assured_updated",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"alteration": "sum_assured_updated"
}
}
policy_premium_updated
policy_premium_updated
Indicates that the policy premium was updated.
{
"event": {
"type": "policy_premium_updated",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
policy_issued
policy_issued
Indicates that the policy was issued.
{
"event": {
"type": "policy_issued",
"created_at": "2017-05-25T13:29:29.356Z",
"metadata": {
"requestedAt": "2017-05-25T13:29:29.291Z",
"requestedBy": {
"type": "user",
"id": "00000000-0000-0000-0000-000000000001"
}
},
"policy_number": "35D33478FC",
"package_name": "Funeral Cover: Main Member",
"sum_assured": 3000300,
"monthly_premium": 2740,
"base_premium": 2131,
"billing_frequency": "monthly",
"billing_amount": 2740,
"billing_day": 1,
"beneficiaries": [
{
"beneficiaryId": "ad1f72bf-ec56-43c1-a65d-db53a1ed4ea0",
"policyId": "6bf58d32-c7da-407e-93ab-83443623e689",
"policyholderId": "5f3d26cc-4efa-4dc8-aea0-e0ce5f3083eb",
"percentage": 100,
"relationship": "policyholder"
}
],
"start_date": "2017-05-25T00:00:00.000Z",
"end_date": "2021-05-25T13:29:29.317Z",
"module": {
"age": 27,
"type": "root_funeral",
"gender": "male",
"cover_amount": 300000,
"spouse_included": false,
"children_included": false,
"extended_family_included": false
},
"application_id": "932c4b97-d736-46ee-b02a-c56eed85ef76",
"policyholder_id": "5f3d26cc-4efa-4dc8-aea0-e0ce5f3083eb",
"scheme_type": "individual",
"currency": "ZAR",
"product_module_id": "1060d3fa-af06-49af-87a8-3e54af259799",
"product_module_definition_id": "b63e8f43-ccc9-4a1c-8867-0643a05f9201",
"charges": [],
"claim_ids": [],
"complaint_ids": [],
"terms_uri": "http://api.rootplatform.com/v1/insurance/policies/6bf58d32-c7da-407e-93ab-83443623e689/terms/terms.pdf",
"policy_id": "6bf58d32-c7da-407e-93ab-83443623e689",
"requested_by": {
"type": "user",
"id": "00000000-0000-0000-0000-000000000001"
}
}
}
policy_not_taken_up
policy_not_taken_up
Indicates that the policy was not taken up.
{
"webhook_id": "a90f3702-7874-4a22-974e-0e1677c3d2dc",
"environment": "sandbox",
"event": {
"type": "policy_not_taken_up",
"created_at": "2023-05-22T10:15:33.916Z",
"metadata": {
"requested_at": "2023-05-22T10:15:33.892Z",
"requested_by": {
"type": "system"
}
},
"terms_uri": "https://sandbox.rootplatform.com/v1/insurance/policies/12346c05-d137-4add-91ba-f1cf099d5fd7/terms/terms.pdf",
"policy_id": "12346c05-d137-4add-91ba-f1cf099d5fd7",
"requested_by": {
"type": "system"
}
},
policy_expired
policy_expired
Indicates that the policy has expired.
{
"webhook_id": "a90f3702-7874-4a22-974e-0e1677c3d2dc",
"environment": "sandbox",
"event": {
"type": "policy_expired",
"created_at": "2023-05-22T10:15:23.586Z",
"metadata": {
"requested_at": "2023-05-22T10:15:23.581Z",
"requested_by": {
"type": "system"
}
},
"terms_uri": "https://sandbox.rootplatform.com/v1/insurance/policies/123a1436-3d24-49bc-ba45-aeb00cf12b7e/terms/terms.pdf",
"policy_id": "123a1436-3d24-49bc-ba45-aeb00cf12b7e",
"requested_by": {
"type": "system"
}
},
policy_lapse_failed
policy_lapse_failed
Indicates that an attempt to lapse the policy failed.
{
"event": {
"type": "policy_lapse_failed",
"created_at": "2017-05-25T14:01:29.733Z",
"metadata": {
"requestedAt": "2017-05-25T14:01:29.636Z",
"requestedBy": {
"type": "api_key",
"id": "420df14d-b09d-4d89-84a8-8e3118c9ca23",
"ownerId": "00000000-0000-0000-0000-000000000001"
}
},
"failure_reason": "Reason for lapse failure",
"policy_id": "2ec443c7-0dc5-4289-938f-fcb84874b334",
"requested_by": {
"type": "api_key",
"id": "420df14d-b09d-4d89-84a8-8e3118c9ca23",
"owner_id": "00000000-0000-0000-0000-000000000001"
}
}
}
policy_lapsed
policy_lapsed
Indicates that the policy was lapsed.
{
"event": {
"type": "policy_lapsed",
"created_at": "2017-05-25T14:01:29.733Z",
"metadata": {
"requestedAt": "2017-05-25T14:01:29.636Z",
"requestedBy": {
"type": "api_key",
"id": "420df14d-b09d-4d89-84a8-8e3118c9ca23",
"ownerId": "00000000-0000-0000-0000-000000000001"
}
},
"terms_uri": "http://api.rootplatform.com:4000/v1/insurance/policies/2ec443c7-0dc5-4289-938f-fcb84874b334/terms/terms.pdf",
"policy_id": "2ec443c7-0dc5-4289-938f-fcb84874b334",
"requested_by": {
"type": "api_key",
"id": "420df14d-b09d-4d89-84a8-8e3118c9ca23",
"owner_id": "00000000-0000-0000-0000-000000000001"
}
}
}
policy_billing_updated
policy_billing_updated
Indicates that the policy billing was updated.
{
"event": {
"type": "policy_billing_updated",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
policy_beneficiaries_updated
policy_beneficiaries_updated
Indicates that the policy beneficiaries were updated
{
"event": {
"type": "policy_altered",
"created_at": "2017-05-25T13:51:12.054Z",
"metadata": {
"requested_at": "2017-05-25T13:51:12.028Z",
"requested_by": {
"type": "user",
"id": "00000000-0000-0000-0000-000000000001"
}
},
"beneficiaries": [
{
"beneficiaryId": "8781cd6a-4bd3-43a7-a24f-1fbe4ef976ac",
"policyId": "0b8abee8-d861-4cf7-abd1-81f10ac01bb3",
"policyholderId": "5f3d26cc-4efa-4dc8-aea0-e0ce5f3083eb",
"percentage": 100,
"relationship": "policyholder",
"paymentDetails": {
"type": "eft",
"details": {
"bankName": "absa",
"branchCode": "12345",
"accountType": "savings_account",
"accountNumber": "123456789"
}
}
}
],
"alteration": "beneficiaries_updated",
"policy_id": "0b8abee8-d861-4cf7-abd1-81f10ac01bb3",
"requested_by": {
"type": "user",
"id": "00000000-0000-0000-0000-000000000001"
}
}
}
policy_activated
policy_activated
Indicates that the policy was activated.
{
"event": {
"type": "policy_activated",
"created_at": "2017-05-25T14:04:13.057Z",
"metadata": {
"requestedAt": "2017-05-25T14:04:13.050Z",
"requestedBy": {
"type": "system"
}
},
"terms_uri": "http://api.rootplatform.com:4000/v1/insurance/policies/4bf927ec-a162-4bfb-b91a-32907df562d7/terms/terms.pdf",
"policy_id": "4bf927ec-a162-4bfb-b91a-32907df562d7",
"requested_by": {
"type": "system"
}
}
}
policy_documents_updated
policy_documents_updated
Indicates that the policy documents were updated.
{
"event": {
"type": "policy_documents_updated",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
policy_schedule_updated
policy_schedule_updated
Indicates that the policy schedule was updated.
{
"event": {
"type": "policy_schedule_updated",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"policy_schedule_uri": "http://app.rootplatform.com/v1/insurance/policies/e325c124-7305-11e7-94d6-c3b7b747a46e/scheduld.pdf"
}
}
policy_welcome_letter_updated
policy_welcome_letter_updated
Indicates that the policy welcome letter was updated.
{
"event": {
"type": "policy_welcome_letter_updated",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
policy_terms_updated
policy_terms_updated
Indicates that policy terms were updated.
{
"event": {
"type": "policy_terms_updated",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
policy_refund_requested
policy_refund_requested
Indicates that a policy refund was requested.
{
"event": {
"type": "policy_refund_requested",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
policy_updated
policy_updated
Indicates that a policy was updated.
{
"event": {
"type": "policy_updated",
"created_at": "2017-05-25T13:41:11.020Z",
"metadata": {
"requestedAt": "2017-05-25T13:41:11.004Z",
"requestedBy": {
"type": "user",
"id": "00000000-0000-0000-0000-000000000001"
}
},
"billing_day": 2,
"terms_uri": "http://api.rootplatform.com:4000/v1/insurance/policies/6a011f43-6282-4959-b9d9-7727326ec0d3/terms/terms.pdf",
"policy_id": "6a011f43-6282-4959-b9d9-7727326ec0d3",
"requested_by": {
"type": "user",
"id": "00000000-0000-0000-0000-000000000001"
}
}
}
policy_cancel_failed
policy_cancel_failed
Indicates that an attempt to cancel the policy failed.
{
"event": {
"type": "policy_cancel_failed",
"created_at": "2017-05-25T14:01:29.733Z",
"metadata": {
"requestedAt": "2017-05-25T14:01:29.636Z",
"requestedBy": {
"type": "api_key",
"id": "420df14d-b09d-4d89-84a8-8e3118c9ca23",
"ownerId": "00000000-0000-0000-0000-000000000001"
}
},
"failure_reason": "Reason for cancel failure",
"policy_id": "2ec443c7-0dc5-4289-938f-fcb84874b334",
"requested_by": {
"type": "api_key",
"id": "420df14d-b09d-4d89-84a8-8e3118c9ca23",
"owner_id": "00000000-0000-0000-0000-000000000001"
}
}
}
policy_cancelled
policy_cancelled
Indicates that a policy was cancelled.
{
"event": {
"type": "policy_cancelled",
"created_at": "2017-05-25T13:31:41.166Z",
"metadata": {
"requestedAt": "2017-05-25T13:31:41.156Z",
"requestedBy": {
"type": "user",
"id": "00000000-0000-0000-0000-000000000001"
}
},
"reason": "Alternate product",
"terms_uri": "http://api.rootplatform.com:4000/v1/insurance/policies/6bf58d32-c7da-407e-93ab-83443623e689/terms/terms.pdf",
"policy_id": "6bf58d32-c7da-407e-93ab-83443623e689",
"requested_by": {
"type": "user",
"id": "00000000-0000-0000-0000-000000000001"
}
}
}
Policyholder events
attachment_created
attachment_created
Indicates that an attachment was created.
{
"event": {
"type": "attachment_created",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"file_name": "attachment",
"file_type": "txt",
"file_url": "http://someurl.com/attachment.txt",
"description": "File containing attachment info"
}
}
text_note_created
text_note_created
Indicates that a text note was created.
{
"event": {
"type": "text_note_created",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"text": "Some text here"
}
}
policyholder_flushed
policyholder_flushed
Indicates that a policyholder was flushed.
{
"event": {
"type": "policyholder_flushed",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
policyholder_policy_issued
policyholder_policy_issued
Indicates that a policy for a policyholder was flushed.
{
"event": {
"type": "policy_issued",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
policyholder_updated
policyholder_updated
Indicates that a policyholder was updated.
{
"event": {
"type": "policyholder_updated",
"created_at": "2017-05-25T13:58:52.285Z",
"first_name": "Erlich",
"last_name": "Bachman",
"title": "Mr",
"company_name": "Pied Piper",
"email": "[email protected]",
"cellphone": "+27763930254",
"phone_other": null,
"app_data": {
"agreed_to_communication": true
},
"policyholder_id": "5f3d26cc-4efa-4dc8-aea0-e0ce5f3083eb",
"requested_by": {
"type": "user",
"id": "00000000-0000-0000-0000-000000000001"
}
}
}
policyholder_created
policyholder_created
Indicates that a policyholder was created.
{
"event": {
"type": "policyholder_created",
"entity_type": "individual",
"created_at": "2022-08-10T14:19:42.773Z",
"identification": {
"type": "id",
"number": "6802057494083",
"country": "ZA"
},
"date_of_birth": "19680205",
"gender": "male",
"first_name": "elrich",
"last_name": "aviato",
"email": "[email protected]",
"cellphone": "+27663633835",
"address": {
"line_1": "2b wheelan street",
"line_2": "rondabosch",
"suburb": "Cape Town",
"city": "Cape Town",
"country": "SD",
"area_code": "12121234"
},
"policyholder_id": "b0bee24b-7459-437b-95e5-6b73d05188af",
"requested_by": {
"type": "api_key",
"id": "d1d9254e-491c-468d-aa26-969cfb2a7db4",
"owner_id": "00000000-0000-0000-0000-000000000001"
}
}
}
Quote package events
quote_package_created
quote_package_created
Indicates that a quote package was created.
{
"event": {
"type": "quote_package_created",
"quote_package_id": "d222b1de-162f-4dc7-8205-8be189c50354",
"package_name": "Funeral Cover: Main Member",
"sum_assured": 2300000,
"base_premium": 1634,
"suggested_premium": 2100,
"module": {
"type": "root_funeral",
"cover_amount": 2300000,
"age": 27,
"gender": "male",
"spouse_included": false,
"children_included": false,
"extended_family_included": false
},
"created_at": "2017-05-25T14:03:22.358Z",
"currency": "ZAR",
"billing_frequency": "monthly"
}
}
Scheduled data export events
scheduled_data_export_resumed
scheduled_data_export_resumed
Indicates that a scheduled data export was resumed.
{
"event": {
"type": "scheduled_data_export_resumed",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
scheduled_data_export_paused
scheduled_data_export_paused
Indicates that a scheduled data export was paused.
{
"event": {
"type": "scheduled_data_export_paused",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
scheduled_data_export_archived
scheduled_data_export_archived
Indicates that a scheduled data export was archived.
{
"event": {
"type": "scheduled_data_export_archived",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
scheduled_data_export_updated
scheduled_data_export_updated
Indicates that a scheduled data export was updated.
{
"event": {
"type": "scheduled_data_export_updated",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"adapter": {
"type": "sftp",
"host": "localhost",
"port": 22,
"username": "erlich",
"password": "topsecret"
}
}
}
scheduled_data_export_created
scheduled_data_export_created
Indicates that a scheduled data export was created.
{
"event": {
"type": "scheduled_data_export_created",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
},
"frequency": {
"type": "daily"
},
"adapter": {
"type": "sftp",
"host": "localhost",
"port": 22,
"username": "erlich",
"password": "topsecret"
}
}
}
Template events
template_archived
template_archived
Indicates that a template was archived.
{
"event": {
"type": "template_archived",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
template_updated
template_updated
Indicates that a template was updated.
{
"event": {
"type": "template_updated",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}
template_created
template_created
Indicates that a template was created.
{
"event": {
"type": "template_created",
"created_at": "2017-10-05T18:28:30+02:00",
"requested_by": {
"type": "system"
}
}
}