Post a typed recipient-side event.
POST /v2/widget/{kind}/{instance_id}/events
Each event is a discriminated-union variant. `Idempotency-Key` MUST equal `event.correlation_id` (per `02-widget-runtime.md` §7.4).
Operation
| Operation ID | postWidgetEvent |
| Tags | Untagged |
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| kind * | path | kind | |
| instance_id * | path | id | |
| Idempotency-Key | header | string | Per `00-conventions.md` §7. Client-generated UUID v4 recommended. |
Request body
Required
object
| Field | Type | Description |
|---|---|---|
| kind * | WidgetEventKind | direct_deposit_submitteddirect_deposit_access_token_requestedcard_on_file_enrolledcard_on_file_notification_requestedmobile_app_download_initiatedmobile_app_download_link_sentenrollment_submittedopt_in_changedsurvey_answer_submittedsurvey_completedsecure_personalization_viewedusps_address_validatedusps_address_submittedotp_requestedotp_verifiedpage_viewedcontent_block_interactedwidget_dismissed |
| emitted_at * | string (date-time) | RFC 3339 / ISO 8601 timestamp. |
| correlation_id * | id | UUID v4. |
| bootstrap_id * | id | UUID v4. |
| payload | object | Per-kind payload per 02-widget-runtime §7.3 |
Responses
202
Accepted
object
| Field | Type | Description |
|---|---|---|
| delivery_id * | id | UUID v4. |
| accepted_at * | emitted_at | RFC 3339 / ISO 8601 timestamp. |
| progress | JourneyProgress |
400
401
403
409
422
Schema validation failed.
schema
429
Rate limit exceeded. See Retry-After + RateLimit-* headers.
schema
Example request
POST https://api.digitalonboarding.com/v2/widget/{kind}/{instance_id}/events
Authorization: Bearer <partner-token>
Content-Type: application/json
Idempotency-Key: <uuid-v4>
{ /* request body matching schema above */ }