Opens a listen session for the caller's merchant and returns its signing secret, once.
POST
/api/notifications/listen-sessions
deprecated
Requires: Notifications.ListenSessions.Listen, merchant scope.
The secret is not recoverable afterwards: only a hash of it is stored. Losing it means opening a new session.
Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.
Example request
Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.
The request body is a CreateListenSessionInput. See the Request body section below for its fields.
Parameters
Request body
application/json
, required
| Field | Type | Description |
|---|---|---|
eventTypes
required |
array of string array of | Event types to stage. Empty means every event type the caller may see, resolved once at
creation and then fixed for the session's lifetime.
nullablemax items 50
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.
|
label
required |
string | Optional human label, so an operator's list reads sensibly.
nullablemax length 128
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) | Requested session lifetime in minutes, renewed by poll activity. Clamped server-side; a value
outside the supported range is corrected, not refused.
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 request body has no documented fields.
Responses
200 The session was opened. The body carries the signing secret, once.
Body:
ListenSessionCreatedDto
ListenSessionCreatedDto
Each item has these 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 response has no documented body fields.
403 The caller has no merchant context, so there is no single merchant to scope a session to.
Body:
Each item has these fields.
| Field | Type | Description |
|---|
This response has no body.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take. The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take.
Body:
RemoteServiceErrorResponse
RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo RemoteServiceErrorInfo |
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 response has no documented body fields.
429 The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.
Body:
RemoteServiceErrorResponse
RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo RemoteServiceErrorInfo |
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 response has no documented body fields.
Errors
A failed request returns the platform error envelope. The
error reference lists every value
error.code can carry and shows the four response shapes.