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

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

<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.

**Operation ID:** `notificationsPoll`

## Authorization

Requires: Notifications.ListenSessions.Listen, merchant scope.

Required permissions:
- `Notifications.ListenSessions.Listen`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| id | path | yes | string(uuid) |  |
| CursorUtc | query | no | 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 | query | no | integer(int32) | Batch size. Clamped server-side. |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Responses

### 200

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

**Content type:** `application/json`

Schema: `ListenSessionEventsDto`

Properties:
- `events` (array<ListenSessionEventDto>): Events after the cursor, oldest first.
- `nextCursorUtc` (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.
- `agedOutGap` (boolean): Set when the caller's cursor predates the oldest event still buffered, meaning events expired  before they were read.
- `oldestAvailableUtc` (string(date-time)): The staging instant of the oldest event still buffered, when there is a gap.
- `expiresAtUtc` (string(date-time)): When the session now expires, after this poll renewed it.

### 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.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 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.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 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.

**Content type:** `application/problem+json`

Schema: `RateLimitProblemDetails`

Properties:
- `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself,  so there is no sub-type for a caller to branch on.
- `title` (string) required: A short, human-readable summary of the problem type.
- `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines.
- `detail` (string) required: A human-readable explanation of this occurrence of the problem.
- `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the  `Retry-After` header. Always at least one: a value of zero would invite an immediate  retry that is certain to be rejected again.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

## 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.

### cURL

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

### PowerShell

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

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

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
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)

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

const data = await response.json();
```

### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
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)

```csharp
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();
```

### Python (SDK)

```bash
pip install winkpg-api
```

```python
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")
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
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()
```

## See also

- [All documentation](https://devportal-simpay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.