# POST /api/notifications/listen-sessions/{id}/sample

Stages the event catalog's sample for one event type into a live session's buffer.

The destination-bound sample send cannot reach a session: it bypasses dispatch entirely. This
is the session-targeted equivalent, built from the same sample factory and the same envelope
leg, so a receiver validated against the published schema is validated against this too.



Sandbox-only. A caller acting in the live world is refused, as is one carrying no evidence of
which world it is acting in: a sample is a synthetic event that never happened, and staging
one into a production feed puts an invented occurrence in front of a receiver processing real
traffic.

**Operation ID:** `notificationsStageSample`

## Authorization

Requires: Notifications.ListenSessions.Listen, Notifications.Destinations.Test, merchant scope.

Required permissions:
- `Notifications.ListenSessions.Listen`
- `Notifications.Destinations.Test`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| id | path | yes | string(uuid) |  |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

**Content type:** `application/json`

Schema: `StageSampleEventInput`

Properties:
- `eventType` (string) required: Canonical event type to build the sample for.

**Content type:** `text/json`

Schema: `StageSampleEventInput`

Properties:
- `eventType` (string) required: Canonical event type to build the sample for.

**Content type:** `application/*+json`

Schema: `StageSampleEventInput`

Properties:
- `eventType` (string) required: Canonical event type to build the sample for.

## Responses

### 200

The sample was staged and will arrive on the next poll.

**Content type:** `application/json`

Schema: `ListenSessionEventDto`

Properties:
- `id` (string(uuid)): The staged-event id. The client's dedupe key across the cursor's overlap window.
- `stagedAtUtc` (string(date-time)): When the event was staged. The first half of the cursor.
- `eventId` (string): The platform event id, forwarded as `X-WinkPG-Event-Id`.
- `eventType` (string): Canonical event type.
- `deliveryId` (string(uuid)): The per-staged-event delivery id, forwarded as `X-WinkPG-Delivery-Id`.
- `isSample` (boolean): Whether this event was staged by a sample request rather than a live occurrence. When true, the  forward to the local target carries `X-WinkPG-Sample: true`, the same marker a sample sent  to a saved endpoint carries. The body is identical either way.
- `payload` (string): The webhook body, verbatim. Forwarded to the local target byte for byte: re-serializing it  client-side would change the bytes the signature covers and break verification.

### 403

The event type is unregistered, undeliverable, or outside the caller's scope; or the caller is
not acting in the test world, which sample events require.

### 404

No such session for this caller, or it is no longer active.

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

The request body is a StageSampleEventInput. See the Request body section below for its fields.

### cURL

```bash
curl -X POST "{{BASE_URL}}/api/notifications/listen-sessions/{id}/sample" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "eventType": ""
}'
```

### PowerShell

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

$body = @'
{
  "eventType": ""
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/notifications/listen-sessions/{id}/sample' `
    -Headers $headers -ContentType 'application/json' -Body $body
```

### 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.notificationsStageSample("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  "eventType": ""
});
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/notifications/listen-sessions/{id}/sample', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "eventType": ""
  }),
});

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;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new NotificationsApi(config);
var body = JsonSerializer.Deserialize<StageSampleEventInput>("""
    {
      "eventType": ""
    }
    """);

var result = await api.NotificationsStageSampleAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), body);
```

### C# (raw HTTP)

```csharp
using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/notifications/listen-sessions/{id}/sample");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "eventType": ""
    }
    """, Encoding.UTF8, "application/json");

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)
    body = winkpg_api.StageSampleEventInput.from_dict({
      "eventType": ""
    })
    result = api.notifications_stage_sample("3fa85f64-5717-4562-b3fc-2c963f66afa6", body)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "eventType": ""
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/notifications/listen-sessions/{id}/sample",
    headers=headers,
    json=body,
)
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.