W2 DocsWebhooks for Bundle Remediation (Alpha)
⚠️ Alpha: Please note webhooks are in an early stage of development and are subject to change.
Purpose
Our Bundle Remediation webhooks have been created to trigger a webhook whenever a Bundle is remediated by a user. This will enable you to utilise any downstream automation like updates on your system.
Getting Set Up
Our Webhooks are a new feature of our remediation system, in order to make use of them you will need to ensure:
- You are using our portal to remediate any KYC checks.
- You have informed us of the callback URL you are listening on.
To establish either of these you can reach out to our Support team who can help you get started.
Sample Payload
The webhook consists of an HTTP POST call with an application/JSON payload.
Custom headers.
| Header | Value |
|---|---|
| x-w2-topic | BundleRemediation |
json
{
"User": "[email protected]",
"CallReference": "WSCRb83xxxx3-2xxb-4d6c-8xxx-c677xxxx084a",
"CaseId": "83xxxx3-2xxb-4d6c-8xxx-c677xxxx084a",
"ClientReference": "your-client-ref",
"BundleRemediationStatus": "Pass",
"Comments": "No match",
"Timestamp": "2024-05-29T00:12:46.7439433+01:00"
}Field Breakdown
| Property | Notes |
|---|---|
| User | The email of the user who performed the remediation. |
| CallReference | The unique identifier for the bundle result. |
| CaseId | The unique identifier for the case associated with the remediated result. |
| ClientReference | A reference identifying this call for your reference. |
| Comments | The comments added during the remediation. |
| BundleStatus | The status of the bundle that it was remediated to. Can be any one of the following: Pass,Fail,Refer |
| Timestamp | A timestamp of the remediation event. |