# The webhook event payload

## Evaluation Events
- **Evaluation Completed**  
- **Evaluation Paused**  
- **Reevaluation**  
- **Workflow Execution Failed**  
- **Decision Updated**  
- **Fraud Confirming**  
- **Case Assigned**  
- **Case Unassigned**  
- **Case Status Updated**  
- **Case Notes Added**  
- **Case Attachment Added**

Triggered when any of the following occur:

- An **asynchronous evaluation** finishes processing.
- A **manually created case** completes processing.
- **Document Verification (DocV)** completes.
- Any **paused evaluation** resumes and completes.

## Event Schema

- **event_id**: `uuid` (required)  
  Unique identifier for the webhook event.
- **event_at**: `date-time` (required)  
  RFC 3339 timestamp when the event was created.
- **event_type**: `string` (enum) (required)  
  Type of event that occurred.
  - Allowed: `evaluation_completed`
- **customer_metadata**: `object`  
  Opaque, caller-owned JSON object, present only when the originating evaluation included it. Returned unchanged at the top level of the envelope, not inside `data`. Up to 200 characters.  
  See [Customer Metadata](https://help.socure.com/riskos/docs/customer-metadata).

### customer_metadata object

- service: `string`
- business_unit: `string`
- internal_ref: `string`

- **data**: `object` (required)  
  Event-specific payload containing evaluation details.

### data object
- **id**: `string`
- **workflow**: `string`
- **workflow_id**: `uuid`
- **workflow_version**: `string`
- **eval_end_time**: `date-time`
- **eval_id**: `uuid`
- **eval_start_time**: `date-time`
- **decision**: `string`
- **decision_at**: `date-time`
- **status**: `string`
- **sub_status**: `string`
- **score**: `integer`
- **environment_name**: `string`
- **tags**: `array`
- **eval_source**: `string`
- **evaluation_status**: `string`
- **notes**: `string`
- **review_queues**: `array`
- **data_enrichments**: `array`

- **data_enrichments object**  
   - enrichment_endpoint: `string`
   - enrichment_name: `string`
   - enrichment_provider: `string`
   - status_code: `integer`
   - is_source_cache: `boolean`
   - total_attempts: `integer`
   - error_message: `string`
   - request: `object`
     - example_email: `string`
     - example_name: `string`
     - example_number: `integer`
     - example_string: `string`
   - response: `object`
     - example_boolean: `boolean`
     - example_list: `array`
       - example_number: `integer`
       - example_string: `string`
     - example_string: `string`

---

**JSON Structure Example:**
```json
{
  "event_id": "336ccd2a-b3a8-49a8-b2cc-89a4ae90feeb",
  "event_at": "2025-08-27T16:16:23.104744158Z",
  "event_type": "evaluation_completed",
  "customer_metadata": {
    "service": "checkout-api",
    "business_unit": "consumer-lending",
    "internal_ref": "order-998877"
  },
  "data": {
    "id": "test-1245",
    "workflow": "consumer_onboarding",
    "workflow_id": "673dd085-3daf-4c6c-be67-d399933a9fec",
    "workflow_version": "1.0.0",
    "eval_end_time": "2025-08-27T16:16:23.098709942Z",
    "eval_id": "8770e076-f568-48a9-8201-dca13087e592",
    "eval_start_time": "2025-08-27T16:16:17.969951775Z",
    "decision": "REVIEW",
    "decision_at": "2025-08-27T16:16:23.096676037Z",
    "status": "OPEN",
    "sub_status": "Surveillance",
    "score": 39,
    "environment_name": "Sandbox",
    "tags": [],
    "eval_source": "API",
    "evaluation_status": "evaluation_completed",
    "notes": "Test Notes",
    "review_queues": ["Default Queue"],
    "data_enrichments": [{
      "enrichment_endpoint": "https://example-endpoint",
      "enrichment_name": "ExampleThirdParty",
      "enrichment_provider": "ExampleProvider",
      "status_code": 200,
      "is_source_cache": false,
      "total_attempts": 1,
      "error_message": "",
      "request": {
        "example_email": "johndoe@email.com",
        "example_name": "John Doe",
        "example_number": 21,
        "example_string": "string"
      },
      "response": {
        "example_boolean": true,
        "example_list": [{
          "example_number": 99,
          "example_string": "Email"
        }, {
          "example_number": 78,
          "example_string": "SSN"
        }],
        "example_string": "string"
      }
    }]
  }
}
```