View as Markdown

llms.txt

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such operation

This instance documents no operation under that identifier. It may have been renamed, or it may belong to a feature this installation hasn't enabled.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-01 06:25 UTC.

API reference Notifications

Sends one webhook delivery to your endpoint again.

POST /api/notifications/events/{id}/replay deprecated

Requires: Notifications.Events.Replay, merchant scope.

This is the other half of recovering from an outage: list what you missed, then ask for the ones that did not land to be sent again. The platform resets the delivery and attempts it on its own delivery path, so the payload, the signature and the headers are the ones your endpoint would have received. <b>What replay can recover, and what it cannot.</b> Only a delivery this platform raised and that ended `Failed`, `DeadLettered` or `Skipped`. An event that never became a delivery cannot be replayed, because there is nothing to send; neither can one that already succeeded. <b>It answers with what happened, so it runs while you wait.</b> One attempt is bounded by the platform's own attempt deadline of two minutes; in practice your endpoint's own timeout ends it far sooner. <b>Three separate limits apply, and none of them needs an idempotency key.</b> Your API key's request limit bounds how often you may ask. A per-endpoint replay budget bounds how much the platform will send to one address in a window, and a request over it is refused without touching the delivery. And asking twice for a delivery that has since succeeded is refused, because a delivered replay is no longer replayable.

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.

Code sample language

cURL
curl -X POST "{{BASE_URL}}/api/notifications/events/{id}/replay" \
  -H "api-key: {{API_KEY}}"

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

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

TypeScript (raw HTTP)
const response = await fetch('{{BASE_URL}}/api/notifications/events/{id}/replay', {
  method: 'POST',
  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.NotificationsReplayWebhookEventAsync(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("POST"), "/api/notifications/events/{id}/replay");
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_replay_webhook_event("3fa85f64-5717-4562-b3fc-2c963f66afa6")

pip install requests

Python (raw HTTP)
import requests

headers = {
    "api-key": "{{API_KEY}}",
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/notifications/events/{id}/replay",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description
id required path string (uuid) The delivery to replay.
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 was reset and attempted. The outcome says whether your endpoint accepted it, refused it, or was never contacted.

Body: WebhookEventReplayResultDto Each item has these fields.

Field Type Description
id required string (uuid) The delivery that was replayed.
outcome required all of WebhookEventReplayOutcome What the platform did about it.

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: Each item has these fields.

Field Type Description

This response has no body.

409 The delivery is not replayable, or its destination endpoint is currently suppressed. Nothing was changed either way.

Body: Each item has these fields.

Field Type Description

This response has no body.

429 This endpoint's replay budget for the current window is spent. Nothing was changed; try again after the window rolls over.

Body: Each item has these fields.

Field Type Description

This response has no body.

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.

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

Authentication

    Reconnecting to the server

    Could not reconnect

    This session has ended

    Attempt 1

    Your work on this page is still here. Retrying keeps it; reloading starts the page again.

    The server no longer holds this page's state, so it has to be loaded again.