Sends one webhook delivery to your endpoint again.

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

Requires: Notifications.Events.Replay, merchant scope.

Requires API key scope: webhooks ()

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. What replay can recover, and what it cannot. 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. It answers with what happened, so it runs while you wait. 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. Three separate limits apply, and none of them needs an idempotency key. 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.

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

cURL PowerShell TypeScript C# Python

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.

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.

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

This request body has no documented fields.

Responses

200 OK

The delivery was reset and attempted. The outcome says whether your endpoint accepted it, refused it, or was never contacted.

Body: WebhookEventReplayResultDto WebhookEventReplayResultDto Each item has these fields.

Field Type Description

id required

string (uuid)

The delivery that was replayed.

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.

outcome required

WebhookEventReplayOutcome WebhookEventReplayOutcome

What the platform did about it.

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`	Your endpoint accepted it.
`Attempted`	Your endpoint was contacted and did not accept it. Read the delivery for the status code and reason it answered with.
`NotSent`	The platform held the delivery back and contacted nothing, which normally means the destination was suppressed or its circuit was open by the time the attempt ran.
`Failed`	The delivery was reset and the attempt ended in a state the platform cannot summarise. Read the delivery to see where it ended up; nothing about it is stranded, and the platform's own retry timer picks up a failed one.

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

This endpoint's replay budget for the current window is spent. Nothing was changed; try again after the window rolls over. A rate limit refusal carries an `application/problem+json` body instead: wait at least the interval `Retry-After` names before retrying, then back off.

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 404 409 default

404 Not Found 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.
409 Conflict The delivery is not replayable, or its destination endpoint is currently suppressed. Nothing was changed either way.
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 one webhook delivery to your endpoint again.

Example request

Parameters

Request body

Responses

Errors

Authentication