# POST /api/notifications/events/replay Sends every replayable delivery in a time window to your endpoints again. 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. **Operation ID:** `notificationsReplayWebhookEvents` ## Authorization Requires: Notifications.Events.Replay, merchant scope. Required permissions: - `Notifications.Events.Replay` ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | suppressNulls | query | no | boolean | If true, omit properties with null values. | ## Request Body The window and any narrowing. **Content type:** `application/json` Schema: `ReplayWebhookEventsInput` Properties: - `fromUtc` (string(date-time)) required: The start of the window, in UTC. - `toUtc` (string(date-time)) required: The end of the window, in UTC. - `status` (object): Narrows to one status. Only `Failed`, `DeadLettered` and `Skipped` can be replayed; leave it unset to take on all three. - `eventType` (string): Narrows to one event type. Leave it unset to take on every event type. **Content type:** `text/json` Schema: `ReplayWebhookEventsInput` Properties: - `fromUtc` (string(date-time)) required: The start of the window, in UTC. - `toUtc` (string(date-time)) required: The end of the window, in UTC. - `status` (object): Narrows to one status. Only `Failed`, `DeadLettered` and `Skipped` can be replayed; leave it unset to take on all three. - `eventType` (string): Narrows to one event type. Leave it unset to take on every event type. **Content type:** `application/*+json` Schema: `ReplayWebhookEventsInput` Properties: - `fromUtc` (string(date-time)) required: The start of the window, in UTC. - `toUtc` (string(date-time)) required: The end of the window, in UTC. - `status` (object): Narrows to one status. Only `Failed`, `DeadLettered` and `Skipped` can be replayed; leave it unset to take on all three. - `eventType` (string): Narrows to one event type. Leave it unset to take on every event type. ## Responses ### 200 The tally of what the run did. **Content type:** `application/json` Schema: `WebhookEventRedriveResultDto` Properties: - `considered` (integer(int32)): Deliveries selected in the window. - `delivered` (integer(int32)): Accepted by your endpoint. - `attempted` (integer(int32)): Contacted and not accepted. - `notSent` (integer(int32)): Held back by the platform; nothing was contacted. - `notRetryable` (integer(int32)): No longer in a replayable state by the time the run reached them. - `suppressed` (integer(int32)): Refused because the destination endpoint is actively suppressed. - `rateLimited` (integer(int32)): Refused because the endpoint's replay budget for this window is spent. - `failed` (integer(int32)): Reset, then the attempt ended in a state the platform cannot summarise. - `notAttempted` (integer(int32)): Selected but never started, because the run reached its time budget. - `reachedCap` (boolean): True when the selection filled the platform's batch cap, so there is likely more in the window. Run the same request again. ### 400 The window is malformed, wider than the platform allows, or narrowed to a status that cannot be replayed. **Content type:** `application/json` Schema: `RemoteServiceErrorResponse` Properties: - `error` (RemoteServiceErrorInfo) ### 403 The credential resolves no single merchant. ### 409 The platform cannot attempt a delivery in its current state. Nothing was changed. **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 ReplayWebhookEventsInput. See the Request body section below for its fields. ### cURL ```bash 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 ```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 ``` ### 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.notificationsReplayWebhookEvents({ "fromUtc": "2026-01-01T00:00:00Z", "toUtc": "2026-01-01T00:00:00Z" }); ``` ### TypeScript (raw HTTP) ```typescript 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(); ``` ### 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(""" { "fromUtc": "2026-01-01T00:00:00Z", "toUtc": "2026-01-01T00:00:00Z" } """); var result = await api.NotificationsReplayWebhookEventsAsync(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/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(); ``` ### 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.ReplayWebhookEventsInput.from_dict({ "fromUtc": "2026-01-01T00:00:00Z", "toUtc": "2026-01-01T00:00:00Z" }) result = api.notifications_replay_webhook_events(body) ``` ### Python (raw HTTP) ```bash pip install requests ``` ```python 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() ``` ## See also - [All documentation](https://devportal-simpay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.