WinkPG Docs

View as Markdown

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:52 UTC.

`WebhookPayloadSchemaDto`

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Self-service description of the webhook payload a subscriber receives for one event type: the schema of the rich `data` body plus a realistic, illustrative sample of the full delivered envelope. Shown in the notification event catalog so you can see the payload shape without firing a real event at a test endpoint.

Values

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields

Field Type Description

eventType required

string

The canonical event type string this schema describes. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

hasRichPayload required

boolean

True when the event delivers a structured `data` object (an aggregate-backed event such as a transaction completion). False for events that deliver only the flat `attributes` map: for those, `dataFields` is empty and the sample shows the flat shape.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

dataFields required

array of WebhookPayloadSchemaField array of WebhookPayloadSchemaField

The schema of the `data` object's fields, generated from the payload CLR type via the same exclusion logic the runtime projector uses. Empty when `hasRichPayload` is false. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of each WebhookPayloadSchemaField:

Field Type Description

name required

string

The JSON field name (the CLR property name, emitted verbatim by the projector). nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

type required

string

The JSON type the value serializes as. One of the values in `WebhookPayloadSchemaTypes`: `string`, `integer`, `number`, `boolean`, `datetime`, `object`, or `array`. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

nullable required

boolean

Whether the field can be `null` / absent. Reference types and `Nullable` value types are nullable; non-nullable value types are not. This is a best-effort hint derived from the CLR type, not a guarantee that the field is always populated.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

description required

string

A curated, integrator-facing note about this field, or `null` when its name and type say enough. Sourced from `WebhookPayloadFieldDescriptions` by the field's dotted path, so the catalog and the delivered payload still come from one traversal. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

fields required

array of WebhookPayloadSchemaField array of WebhookPayloadSchemaField

For `type` == `object`: the nested fields of the object. Null for scalar fields. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

items required

WebhookPayloadSchemaField WebhookPayloadSchemaField

For `type` == `array`: a descriptor for the array's element. The element descriptor's `name` is empty. Null for non-array fields.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

truncated required

boolean

True when the describe walk stopped at this node because the recursion-depth ceiling or a type cycle was hit. The actual delivered payload carries a `__truncated` marker in the same place. Defensive guard: not expected on today's tree-shaped aggregates.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

sampleEnvelopeJson required

string

A pretty-printed, illustrative sample of the full webhook envelope (id, type, version, createdUtc, scope ids, correlationId, data) with placeholder values. For display only: the values are synthetic, the shape is real. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This model has no documented fields.