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

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

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

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.

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 StageSampleEventInput. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

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

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

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

TypeScript (raw HTTP)

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();

dotnet add package WinkPg.Api.Client

C# (SDK)

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)

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();

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

pip install requests

Python (raw HTTP)

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()

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
`eventType` required	string	Canonical event type to build the sample for. nullablemax length 256

This request body has no documented fields.

Responses

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

Body: ListenSessionEventDto Each item has these fields.

Field	Type	Description
`id` required	string (uuid)	The staged-event id. The client's dedupe key across the cursor's overlap window.
`stagedAtUtc` required	string (date-time)	When the event was staged. The first half of the cursor.
`eventId` required	string	The platform event id, forwarded as `X-WinkPG-Event-Id`. nullable
`eventType` required	string	Canonical event type. nullable
`deliveryId` required	string (uuid)	The per-staged-event delivery id, forwarded as `X-WinkPG-Delivery-Id`.
`isSample` required	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` required	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. nullable

This response has no documented body fields.

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.

Body: Each item has these fields.

Field	Type	Description

This response has no body.

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

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

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

Example request

Parameters

Request body

Responses

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

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.

Errors

Authentication