RiskOS™ Webhook

wbhk

client_webhook_endpoint

The webhook payload RiskOS™ sends to your endpoint when a subscribed event occurs, such as a completed evaluation or a case update.

Payload

The webhook event payload.

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_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:

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.

data

object

required

Event-specific payload containing evaluation details.

Responses

200

Webhook received successfully. RiskOS™ expects a 200 response to confirm receipt.

400

Bad Request – The request was invalid or cannot be otherwise served.

500

Internal Server Error – An unexpected condition occurred on the server.

Loading…