{
"id": "event_mZj6YGXhQyQnccN97aXbq",
"type": "policy-update.request-initiated",
"data": {
"client": "cli_mZj6YGXhQyQnccN97aXbq",
"policy": "pol_mZj6YGXhQyQnccN97aXbq",
"operation": "update-third-party",
"input": {
"lenderCode": "ABC123"
},
"unsupportedInputs": [],
"user": {
"firstName": "John",
"lastName": "Doe",
"id": "usr_123456789",
"email": "john.doe@gmail.com"
},
"metadata": {
"claimNumber": "123456"
}
},
"createdAt": "2026-01-01T00:00:00.000Z"
}Webhooks
Policy Update Events
Sent to your webhookUri at each stage of a Policy Update’s lifecycle: policy-update.request-initiated -> policy-update.request-succeeded or policy-update.request-failed -> (on success) policy-update.policy-refresh-succeeded or policy-update.policy-refresh-failed.
WEBHOOK
policyUpdateEvents
{
"id": "event_mZj6YGXhQyQnccN97aXbq",
"type": "policy-update.request-initiated",
"data": {
"client": "cli_mZj6YGXhQyQnccN97aXbq",
"policy": "pol_mZj6YGXhQyQnccN97aXbq",
"operation": "update-third-party",
"input": {
"lenderCode": "ABC123"
},
"unsupportedInputs": [],
"user": {
"firstName": "John",
"lastName": "Doe",
"id": "usr_123456789",
"email": "john.doe@gmail.com"
},
"metadata": {
"claimNumber": "123456"
}
},
"createdAt": "2026-01-01T00:00:00.000Z"
}Body
application/json
- Policy Update Request Initiated
- Policy Update Request Succeeded
- Policy Update Request Failed
- Policy Update Policy Refresh Succeeded
- Policy Update Policy Refresh Failed
Shared fields present on every webhook event payload.
Response
200
Return a 200 status code to acknowledge receipt of the event.
Was this page helpful?