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

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`

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`.
- `eventId` (string): The envelope event id, which is what deduplicates a redelivery.
- `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.
- `status` (object): Where the delivery got to.
- `attemptCount` (integer(int32)): How many attempts have run.
- `durationMs` (integer(int64)): How long the most recent attempt took, or `null` when none has run.
- `httpStatusCode` (integer(int32)): The status code the endpoint answered with, or `null` when it never answered.
- `destinationName` (string): The merchant's own name for the destination the delivery was addressed to.
- `httpStatusReason` (string): The reason phrase the endpoint sent back with its status code, when it sent one.
- `destinationEndpoint` (string): The address the platform posted to.
- `correlationId` (string): The platform correlation id, for a support conversation.
- `eventPayloadJson` (string): The body the platform posted, byte for byte, when the platform can confirm it; otherwise  `null`, with `eventPayloadUnavailableReason` saying why.
- `eventPayloadUnavailableReason` (object): Why `eventPayloadJson` is withheld, or `null` whenever the body is present.

### 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`

Properties:
- `error` (RemoteServiceErrorInfo)

### 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/{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-simpay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.