Sends every replayable delivery in a time window to your endpoints again.

POST /api/notifications/events/replay deprecated

Requires: Notifications.Events.Replay, merchant scope.

Requires API key scope: webhooks ()

The bulk form of the single replay, for a receiver that was down: give it the window your receiver was unavailable for and the platform replays what did not land, one delivery at a time, on its own delivery path. The window says what to look at; it does not say how much this call will do. One call takes on at most a hundred deliveries and spends at most sixty seconds starting them, plus however long the last one it started takes to reach a verdict. Everything it selected but never reached is reported as `notAttempted` rather than dropped. Run the same request again while `reachedCap` is true or `notAttempted` is above zero, until both are clear. Running it again is safe and needs no idempotency key. A delivery that succeeded on the previous run is no longer replayable, so a repeat run only touches what is still outstanding. The same per-endpoint replay budget applies, shared with the single replay, so a run against a receiver that has only just come back cannot stampede it. Deliveries the budget refused are counted under `rateLimited` and are untouched, so a later run picks them up.

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

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/notifications/events/replay" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "fromUtc": "2026-01-01T00:00:00Z",
  "toUtc": "2026-01-01T00:00:00Z"
}'

PowerShell

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

$body = @'
{
  "fromUtc": "2026-01-01T00:00:00Z",
  "toUtc": "2026-01-01T00:00:00Z"
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/notifications/events/replay' `
    -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.notificationsReplayWebhookEvents({
  "fromUtc": "2026-01-01T00:00:00Z",
  "toUtc": "2026-01-01T00:00:00Z"
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/notifications/events/replay', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "fromUtc": "2026-01-01T00:00:00Z",
    "toUtc": "2026-01-01T00:00:00Z"
  }),
});

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<ReplayWebhookEventsInput>("""
    {
      "fromUtc": "2026-01-01T00:00:00Z",
      "toUtc": "2026-01-01T00:00:00Z"
    }
    """);

var result = await api.NotificationsReplayWebhookEventsAsync(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/events/replay");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "fromUtc": "2026-01-01T00:00:00Z",
      "toUtc": "2026-01-01T00:00:00Z"
    }
    """, 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.ReplayWebhookEventsInput.from_dict({
      "fromUtc": "2026-01-01T00:00:00Z",
      "toUtc": "2026-01-01T00:00:00Z"
    })
    result = api.notifications_replay_webhook_events(body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "fromUtc": "2026-01-01T00:00:00Z",
  "toUtc": "2026-01-01T00:00:00Z"
}

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

Parameters

Name In Type Description

suppressNulls required

query

boolean

If true, omit properties with null values.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Request body

application/json , required

Field Type Description

fromUtc required

string (date-time)

The start of the window, in UTC.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

toUtc required

string (date-time)

The end of the window, in UTC.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

status required

DeliveryStatus DeliveryStatus

Narrows to one status. Only `Failed`, `DeadLettered` and `Skipped` can be replayed; leave it unset to take on all three. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

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

eventType required

string

Narrows to one event type. Leave it unset to take on every event type. nullablemax length 512

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This request body has no documented fields.

Responses

200 OK

The tally of what the run did.

Body: WebhookEventRedriveResultDto WebhookEventRedriveResultDto Each item has these fields.

Field Type Description

considered required

integer (int32)

Deliveries selected in the window.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

delivered required

integer (int32)

Accepted by your endpoint.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

attempted required

integer (int32)

Contacted and not accepted.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

notSent required

integer (int32)

Held back by the platform; nothing was contacted.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

notRetryable required

integer (int32)

No longer in a replayable state by the time the run reached them.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

suppressed required

integer (int32)

Refused because the destination endpoint is actively suppressed.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

rateLimited required

integer (int32)

Refused because the endpoint's replay budget for this window is spent.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

failed required

integer (int32)

Reset, then the attempt ended in a state the platform cannot summarise.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

notAttempted required

integer (int32)

Selected but never started, because the run reached its time budget.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

reachedCap required

boolean

True when the selection filled the platform's batch cap, so there is likely more in the window. Run the same request again.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

403 Forbidden

The credential resolves no single merchant.

Body: Each item has these fields.

Field	Type	Description

This response has no body.

429 Too Many Requests

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

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

Errors 400 409 default

400 Bad Request The window is malformed, wider than the platform allows, or narrowed to a status that cannot be replayed.
409 Conflict The platform cannot attempt a delivery in its current state. Nothing was changed.
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 lists the values `error.code` can take.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 lists the values `error.code` can take.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of RemoteServiceErrorInfo:

Field Type Description

code required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

message required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

details required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

data required

object

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

validationErrors required

array of RemoteServiceValidationErrorInfo array of RemoteServiceValidationErrorInfo

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

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

ApiKey with scopes

The API reference isn't available right now

No such operation

This reference may be out of date

Sends every replayable delivery in a time window to your endpoints again.

Example request

Parameters

Request body

Responses

Errors

Authentication