# GET /api/notifications/events

Lists the webhooks sent to your endpoints in a time window.

Newest first. This is how a receiver that was unavailable discovers what it missed: ask for the
window your receiver was down for, narrow to `Failed` or `DeadLettered` if you only
want the ones that did not land, and follow the continuation token until it comes back empty.



The window is bounded, and a wider one is refused rather than quietly narrowed: on a recovery
call, an answer silently missing eleven months would look exactly like a merchant who sent
nothing. Read a longer period in steps.



The bodies are not on this response. Fetch the ones you need individually.

**Operation ID:** `notificationsGetWebhookEvents`

## Authorization

Requires: Notifications.Events, merchant scope.

Required permissions:
- `Notifications.Events`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| FromUtc | query | yes | string(date-time) | Start of the window, inclusive, in UTC. |
| ToUtc | query | yes | string(date-time) | End of the window, inclusive, in UTC. |
| Status | query | no | DeliveryStatus | Show only deliveries in this state, or every state when omitted. |
| EventType | query | no | string | Show only this exact event type, or every type when omitted. |
| MaxResultCount | query | no | integer(int32) | How many deliveries this page should carry. Defaults to  `DefaultPageSize`. |
| ContinuationToken | query | no | string | The token the previous page returned, or `null` for the first page. |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Responses

### 200

One page of deliveries, plus the token that fetches the next.

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

Schema: `WebhookEventPageDto`

Properties:
- `items` (array<WebhookEventDto>): The deliveries on this page, newest first.
- `continuationToken` (string): The token that fetches the next page, or `null` at the end.

### 403

The credential resolves no single merchant, so there is no one merchant's deliveries to answer
with.

### 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/events?FromUtc=2026-01-01T00%3A00%3A00Z&ToUtc=2026-01-01T00%3A00%3A00Z" \
  -H "api-key: {{API_KEY}}"
```

### PowerShell

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

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/notifications/events?FromUtc=2026-01-01T00%3A00%3A00Z&ToUtc=2026-01-01T00%3A00%3A00Z' `
    -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.notificationsGetWebhookEvents("2026-01-01T00:00:00Z", "2026-01-01T00:00:00Z");
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/notifications/events?FromUtc=2026-01-01T00%3A00%3A00Z&ToUtc=2026-01-01T00%3A00%3A00Z', {
  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.NotificationsGetWebhookEventsAsync(DateTime.Parse("2026-01-01T00:00:00Z"), DateTime.Parse("2026-01-01T00:00:00Z"));
```

### C# (raw HTTP)

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

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/notifications/events?FromUtc=2026-01-01T00%3A00%3A00Z&ToUtc=2026-01-01T00%3A00%3A00Z");
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_get_webhook_events("2026-01-01T00:00:00Z", "2026-01-01T00:00:00Z")
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/notifications/events?FromUtc=2026-01-01T00%3A00%3A00Z&ToUtc=2026-01-01T00%3A00%3A00Z",
    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.