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
ListenSessionCreatedDtoA model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
The result of opening a session. The only place the signing secret is ever returned.
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 session id, used on the poll, sample and end routes.
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.
signingSecret
required string
The signing secret, shown exactly once.
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.
merchantId
required string (uuid)
The merchant the session is scoped to.
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.
eventTypes
required array of string
array of The resolved event types the session stages.
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.
expiresAtUtc
required string (date-time)
When the session expires unless polling renews it.
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.
ttlMinutes
required integer (int32)
The clamped session lifetime, in minutes, that each poll renews by.
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.
Next steps