Returns events staged after the cursor, oldest first, and renews the session.

GET /api/notifications/listen-sessions/{id}/events deprecated

Requires: Notifications.ListenSessions.Listen, merchant scope.

<b>Excluded from the per-request log and from traffic aggregation.</b> A listener polls this on a timer for as long as a developer leaves it running: at a one-second interval that is roughly 86,000 log rows a day, which would bury the API calls the developer opened their logs page to find, and would out-weigh a merchant's real traffic in every aggregation chart. The volume is still visible, on `ListenSessionMetrics`; an exclusion without a counter behind it is just a blind spot. The exclusions are per action. Session create, sample and end on this same controller stay captured and audited, because those are the calls that say something happened.

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 . See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X GET "{{BASE_URL}}/api/notifications/listen-sessions/{id}/events" \
  -H "api-key: {{API_KEY}}"

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/notifications/listen-sessions/{id}/events' `
    -Headers $headers

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, NotificationsApi } from '@winkpg/winkpg-api';

const api = new NotificationsApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.notificationsPoll("3fa85f64-5717-4562-b3fc-2c963f66afa6");

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/notifications/listen-sessions/{id}/events', {
  method: 'GET',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new NotificationsApi(config);
var result = await api.NotificationsPollAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"));

C# (raw HTTP)

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/notifications/listen-sessions/{id}/events");
request.Headers.Add("api-key", "{{API_KEY}}");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.NotificationsApi(client)
    result = api.notifications_poll("3fa85f64-5717-4562-b3fc-2c963f66afa6")

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
}

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/notifications/listen-sessions/{id}/events",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`id` required	path	string (uuid)
`CursorUtc` required	query	string (date-time)	The cursor from the previous poll, or `null` to start at the oldest buffered event. The server re-reads a short window before this instant, so the client must dedupe.
`MaxResultCount` required	query	integer (int32)	Batch size. Clamped server-side.
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description

This request body has no documented fields.

Responses

200 Events after the cursor, oldest first. May be empty.

Body: ListenSessionEventsDto Each item has these fields.

Field	Type	Description
`events` required	array of ListenSessionEventDto	Events after the cursor, oldest first. nullable
`nextCursorUtc` required	string (date-time)	The cursor to send on the next poll: the staging instant of the last event returned, or the cursor the caller sent when nothing was returned. nullable
`agedOutGap` required	boolean	Set when the caller's cursor predates the oldest event still buffered, meaning events expired before they were read.
`oldestAvailableUtc` required	string (date-time)	The staging instant of the oldest event still buffered, when there is a gap. nullable
`expiresAtUtc` required	string (date-time)	When the session now expires, after this poll renewed it.

This response has no documented body fields.

404 No such session for this caller. A wrong id, another merchant's session, an ended session and an expired one are deliberately indistinguishable, so an id-shaped probe learns nothing.

Body: RemoteServiceErrorResponse Each item has these fields.

Field	Type	Description
`error` required	RemoteServiceErrorInfo

This response has no documented body fields.

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. See the error-code reference in this document's description for the values `error.code` can take.

Body: RemoteServiceErrorResponse Each item has these fields.

Field	Type	Description
`error` required	RemoteServiceErrorInfo

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 Each item has these fields.

Field	Type	Description
`error` required	RemoteServiceErrorInfo

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.

Codes declared by Notifications

The API reference isn't available right now

No such operation

This reference may be out of date

Returns events staged after the cursor, oldest first, and renews the session.

Example request

Parameters

Request body

Responses

200 Events after the cursor, oldest first. May be empty.

404 No such session for this caller. A wrong id, another merchant's session, an ended session and an expired one are deliberately indistinguishable, so an id-shaped probe learns nothing.

Errors

Authentication