# GET /api/notifications/events/{id} Reads one webhook delivery, including the body posted to your endpoint. 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. **Operation ID:** `notificationsGetWebhookEvent` ## Authorization Requires: Notifications.Events, merchant scope. Requires API key scope: `webhooks` Required permissions: - `Notifications.Events` ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | id | path | yes | string(uuid) | | | suppressNulls | query | no | boolean | If true, omit properties with null values. | ## Responses ### 200 The delivery, including its payload or the reason it is withheld. **Content type:** `application/json` Schema: [`WebhookEventDetailDto`](https://devportal.demo.winkpg.io/docs/api/models/WebhookEventDetailDto.md) Properties: - `id` (string(uuid)): The delivery's id, which is what the detail read takes. - `eventType` (string): The event type that was delivered, for example `transaction.created`. (nullable) - `eventId` (string): The envelope event id, which is what deduplicates a redelivery. (nullable) - `occurredAtUtc` (string(date-time)): When the originating event happened, in UTC. - `lastAttemptUtc` (string(date-time)): When the most recent attempt ran, in UTC, or `null` before the first. (nullable) - `status` ([DeliveryStatus](https://devportal.demo.winkpg.io/docs/api/models/DeliveryStatus.md)): Where the delivery got to. Values: - `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` (integer(int32)): How many attempts have run. - `durationMs` (integer(int64)): How long the most recent attempt took, or `null` when none has run. (nullable) - `httpStatusCode` (integer(int32)): The status code the endpoint answered with, or `null` when it never answered. (nullable) - `destinationName` (string): The merchant's own name for the destination the delivery was addressed to. (nullable) - `relatedEntityType` (string): The kind of record the event was about, for example `Transaction`, or `null` when the delivery carries no such reference. (nullable) - `relatedEntityId` (string(uuid)): The id of the record `relatedEntityType` names, or `null` when the delivery carries no such reference. (nullable) - `httpStatusReason` (string): The reason phrase the endpoint sent back with its status code, when it sent one. (nullable) - `destinationEndpoint` (string): The address the platform posted to. (nullable) - `correlationId` (string): The platform correlation id, for a support conversation. (nullable) - `eventPayloadJson` (string): The body the platform posted, byte for byte, when the platform can confirm it; otherwise `null`, with `eventPayloadUnavailableReason` saying why. (nullable) - `eventPayloadUnavailableReason` ([WebhookEventPayloadUnavailableReason](https://devportal.demo.winkpg.io/docs/api/models/WebhookEventPayloadUnavailableReason.md)): Why `eventPayloadJson` is withheld, or `null` whenever the body is present. (nullable) Values: - `TextTemplate`: The destination posts a body rendered from a custom text template, which the platform does not reproduce after delivery. - `RebuildMismatch`: The body rebuilt from the stored event does not match the body the platform recorded when it posted, most often because the destination's settings changed after the delivery. - `DestinationConfigurationUnreadable`: The destination's stored settings cannot be read, so the platform cannot tell which body it would have posted. ### 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. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Resource not found_ The id in the path names no record the caller can see. Most resources answer with a null error.code and a message naming the resource type and the id; a resource that publishes a not-found code in the catalog above carries it in error.code instead, so check for one before matching on the message. ```json { "error": { "code": "null", "message": "There is no entity Transaction with id = 7d1f3a52-0c4e-4b8a-9e21-5a6b7c8d9e00!", "details": "null", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": "null" } } ``` ### 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](https://devportal.demo.winkpg.io/docs/errors.md) lists the values `error.code` can take. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Business rule refused the request_ The request was understood and rejected by a platform rule. This is the shape that carries a code from the catalog above, so branch on error.code rather than on the message text. The HTTP status is the one listed against the code. ```json { "error": { "code": "Transactions:OperationNotAllowed", "message": "The operation 'Void' is not allowed on a Sale transaction with result 'Approved' and settlement state 'Settled'.", "details": "null", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": "null" } } ``` _Example: Request failed validation_ One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing. ```json { "error": { "code": "null", "message": "Your request is not valid!", "details": "The following errors were detected during validation.", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": [ { "message": "'Amount' must be greater than 0.", "members": [ "amount" ] }, { "message": "The card has expired.", "members": [ "expirationDate" ], "code": "CardData:CardExpired" }, { "message": "'Value' must not be empty.", "members": [ "value" ], "memberPaths": [ "customFields[2].value" ] } ] } } ``` _Example: Unexpected server fault_ Something failed that no rule anticipated. There is no code to branch on and the message is deliberately generic: the diagnostic detail stays in the platform's logs rather than going to the caller. Quote error.data.correlationId (the same value as the X-Correlation-Id response header) when you contact support: it's what finds the failure in those logs. Retrying an unsafe operation after this risks a duplicate, so reconcile before you retry. ```json { "error": { "code": "null", "message": "An internal error occurred during your request!", "details": "null", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": "null" } } ``` ### 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`](https://devportal.demo.winkpg.io/docs/api/models/RateLimitProblemDetails.md) 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. (nullable) - `title` (string) required: A short, human-readable summary of the problem type. (nullable) - `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. (nullable) - `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`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ## 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/{id}" \ -H "api-key: {{API_KEY}}" ``` ### PowerShell ```powershell $headers = @{ 'api-key' = '{{API_KEY}}' } $response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/notifications/events/{id}' ` -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.notificationsGetWebhookEvent("3fa85f64-5717-4562-b3fc-2c963f66afa6"); ``` ### TypeScript (raw HTTP) ```typescript const response = await fetch('{{BASE_URL}}/api/notifications/events/{id}', { 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.NotificationsGetWebhookEventAsync(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/events/{id}"); 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_event("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/events/{id}", headers=headers, ) response.raise_for_status() data = response.json() ``` ## See also - [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.