Reads one webhook delivery, including the body posted to your endpoint.

GET /api/notifications/events/{id} deprecated

Requires: Notifications.Events, merchant scope.

When the platform can confirm it, the body is the payload your endpoint was sent, byte for byte: the standard envelope with its `data` body, exactly as a replay would send it. A receiver recovering a missed event can process it the way it would have processed the original. The platform rebuilds the body from the stored event and checks the result against a hash it recorded when it posted. When it cannot produce a body it can stand behind, the body is `null` and `eventPayloadUnavailableReason` says why: the destination posts a body rendered from a custom text template, the rebuild no longer matches what was posted (usually because the destination's settings changed after the delivery), or the destination's settings cannot be read. A delivery recorded before the hash existed is served from the rebuild without that check. Reading a delivery changes nothing about it: it is not a replay, and no request leaves the platform.

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/{id}" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/notifications/events/{id}' `
    -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.notificationsGetWebhookEvent("3fa85f64-5717-4562-b3fc-2c963f66afa6");

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/notifications/events/{id}', {
  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.NotificationsGetWebhookEventAsync(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/events/{id}");
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_event("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/events/{id}",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`id` required	path	string (uuid)
`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 The delivery, including its payload or the reason it is withheld.

Body: WebhookEventDetailDto Each item has these fields.

Field	Type	Description
`id` required	string (uuid)	The delivery's id, which is what the detail read takes.
`eventType` required	string	The event type that was delivered, for example `transaction.created`. nullable
`eventId` required	string	The envelope event id, which is what deduplicates a redelivery. nullable
`occurredAtUtc` required	string (date-time)	When the originating event happened, in UTC.
`lastAttemptUtc` required	string (date-time)	When the most recent attempt ran, in UTC, or `null` before the first. nullable
`status` required	all of DeliveryStatus	Where the delivery got to.
`attemptCount` required	integer (int32)	How many attempts have run.
`durationMs` required	integer (int64)	How long the most recent attempt took, or `null` when none has run. nullable
`httpStatusCode` required	integer (int32)	The status code the endpoint answered with, or `null` when it never answered. nullable
`destinationName` required	string	The merchant's own name for the destination the delivery was addressed to. nullable
`httpStatusReason` required	string	The reason phrase the endpoint sent back with its status code, when it sent one. nullable
`destinationEndpoint` required	string	The address the platform posted to. nullable
`correlationId` required	string	The platform correlation id, for a support conversation. nullable
`eventPayloadJson` required	string	The body the platform posted, byte for byte, when the platform can confirm it; otherwise `null`, with `eventPayloadUnavailableReason` saying why. nullable
`eventPayloadUnavailableReason` required	all of WebhookEventPayloadUnavailableReason	Why `eventPayloadJson` is withheld, or `null` whenever the body is present. nullable

This response has no documented body fields.

403 The credential resolves no single merchant.

Body: Each item has these fields.

Field	Type	Description

This response has no body.

404 No such delivery for this merchant. A mistyped id, another merchant's id and a delivery on a channel this surface does not publish are deliberately indistinguishable.

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

Reads one webhook delivery, including the body posted to your endpoint.

Example request

Parameters

Request body

Responses

200 The delivery, including its payload or the reason it is withheld.

403 The credential resolves no single merchant.

404 No such delivery for this merchant. A mistyped id, another merchant's id and a delivery on a channel this surface does not publish are deliberately indistinguishable.

Errors

Authentication