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

GET /api/notifications/events deprecated

Requires: Notifications.Events, merchant scope.

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.

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

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

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.notificationsGetWebhookEvents("2026-01-01T00:00:00Z", "2026-01-01T00:00:00Z");

TypeScript (raw HTTP)

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

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.NotificationsGetWebhookEventsAsync(DateTime.Parse("2026-01-01T00:00:00Z"), DateTime.Parse("2026-01-01T00:00:00Z"));

C# (raw HTTP)

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

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_get_webhook_events("2026-01-01T00:00:00Z", "2026-01-01T00:00:00Z")

pip install requests

Python (raw HTTP)

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

Parameters

Name	In	Type	Description
`FromUtc` required	query	string (date-time)	Start of the window, inclusive, in UTC.
`ToUtc` required	query	string (date-time)	End of the window, inclusive, in UTC.
`Status` required	query	DeliveryStatus	Show only deliveries in this state, or every state when omitted.
`EventType` required	query	string	Show only this exact event type, or every type when omitted.
`MaxResultCount` required	query	integer (int32)	How many deliveries this page should carry. Defaults to `DefaultPageSize`.
`ContinuationToken` required	query	string	The token the previous page returned, or `null` for the first page.
`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 One page of deliveries, plus the token that fetches the next.

Body: WebhookEventPageDto Each item has these fields.

Field	Type	Description
`items` required	array of WebhookEventDto	The deliveries on this page, newest first. nullable
`continuationToken` required	string	The token that fetches the next page, or `null` at the end. nullable

This response has no documented body fields.

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

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

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

Example request

Parameters

Request body

Responses

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

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

Errors

Authentication