WinkPG Docs
View as Markdown

llms.txt

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.

API reference Models

ListenSessionEventDto

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

One staged event, as the poll returns it.

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
id required string (uuid) The staged-event id. The client's dedupe key across the cursor's overlap window.
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.
stagedAtUtc required string (date-time) When the event was staged. The first half of the cursor.
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.
eventId required string The platform event id, forwarded as `X-WinkPG-Event-Id`. 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.
eventType required string Canonical event type. 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.
deliveryId required string (uuid) The per-staged-event delivery id, forwarded as `X-WinkPG-Delivery-Id`.
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.
isSample required boolean Whether this event was staged by a sample request rather than a live occurrence. When true, the forward to the local target carries `X-WinkPG-Sample: true`, the same marker a sample sent to a saved endpoint carries. The body is identical either way.
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.
payload required string The webhook body, verbatim. Forwarded to the local target byte for byte: re-serializing it client-side would change the bytes the signature covers and break verification. 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.

Reconnecting to the server

Could not reconnect

This session has ended

Attempt 1

Your work on this page is still here. Retrying keeps it; reloading starts the page again.

The server no longer holds this page's state, so it has to be loaded again.