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

GET /api/notifications/events deprecated

Requires: Notifications.Events, merchant scope.

Requires API key scope: webhooks ()

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. Each item is one delivery: an event sent to three of your endpoints is three items with the same `eventId`. Pass `eventId` to read every delivery of one event and see which of your endpoints received it. 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.

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.

ToUtc required

query

string (date-time)

End of the window, inclusive, in UTC.

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.

Status required

query

DeliveryStatus DeliveryStatus

Show only deliveries in this state, or every state when omitted.

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.

`Pending`	Delivery work item created but not yet picked up by a processor.
`Processing`	Delivery is currently being processed (in-flight).
`Succeeded`	Delivery completed successfully. The destination acknowledged receipt.
`Failed`	Delivery failed but may be retried. Check AttemptCount and LastError for details.
`DeadLettered`	Delivery exhausted all retry attempts and has been moved to the dead letter queue. Requires manual investigation.
`Skipped`	Delivery was skipped (not attempted) due to kill switch, disabled destination, or other policy reason. Check SkipReason for details.

EventType required

query

string

Show only this exact event type, or every type when omitted.

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.

EventId required

query

string

Show only the deliveries of this one event, or every event when omitted.

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.

MaxResultCount required

query

integer (int32)

How many deliveries this page should carry. Defaults to `DefaultPageSize`.

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.

ContinuationToken required

query

string

The token the previous page returned, or `null` for the first page.

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.

suppressNulls required

query

boolean

If true, omit properties with null values.

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.

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

Field Type Description

items required

array of WebhookEventDto array of WebhookEventDto

The deliveries on this page, newest first. 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.

Fields of each WebhookEventDto:

Field Type Description

id required

string (uuid)

The delivery's id, which is what the detail read takes.

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.

eventType required

string

The event type that was delivered, for example `transaction.created`. 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.

eventId required

string

The envelope event id, which is what deduplicates a redelivery. 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.

occurredAtUtc required

string (date-time)

When the originating event happened, in UTC.

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.

lastAttemptUtc required

string (date-time)

When the most recent attempt ran, in UTC, or `null` before the first. 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.

status required

DeliveryStatus DeliveryStatus

Where the delivery got 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.

`Pending`	Delivery work item created but not yet picked up by a processor.
`Processing`	Delivery is currently being processed (in-flight).
`Succeeded`	Delivery completed successfully. The destination acknowledged receipt.
`Failed`	Delivery failed but may be retried. Check AttemptCount and LastError for details.
`DeadLettered`	Delivery exhausted all retry attempts and has been moved to the dead letter queue. Requires manual investigation.
`Skipped`	Delivery was skipped (not attempted) due to kill switch, disabled destination, or other policy reason. Check SkipReason for details.

attemptCount required

integer (int32)

How many attempts have run.

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.

durationMs required

integer (int64)

How long the most recent attempt took, or `null` when none has run. 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.

httpStatusCode required

integer (int32)

The status code the endpoint answered with, or `null` when it never answered. 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.

destinationName required

string

The merchant's own name for the destination the delivery was addressed to. 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.

relatedEntityType required

string

The kind of record the event was about, for example `Transaction`, or `null` when the delivery carries no such reference. 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.

relatedEntityId required

string (uuid)

The id of the record `relatedEntityType` names, or `null` when the delivery carries no such reference. 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 body has no documented fields.

continuationToken required

string

The token that fetches the next page, or `null` at the end. 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 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. 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.

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