Starts a signing-secret rotation.

POST /api/notifications/destinations/{id}/secret-rotation/begin deprecated

Requires: Notifications.Destinations, Notifications.Destinations.Update, merchant scope.

The destination begins signing every delivery with both the current secret and the replacement, emitting two comma-separated `v1=sha256:` entries in `X-WinkPG-Signature` until the rotation is promoted or cancelled. The response carries the replacement secret in plaintext, and is the only place it is ever returned. Confirm the receiver reads every comma-separated entry in the signature header before calling this: a receiver that reads one value rejects every delivery for the length of the overlap, and repeated rejections durably suppress the endpoint.

Try this in the console

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

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/notifications/destinations/{id}/secret-rotation/begin" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "incomingSecretKey": ""
}'

PowerShell

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

$body = @'
{
  "incomingSecretKey": ""
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/notifications/destinations/{id}/secret-rotation/begin' `
    -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.notificationsBeginSecretRotation("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  "incomingSecretKey": ""
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/notifications/destinations/{id}/secret-rotation/begin', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "incomingSecretKey": ""
  }),
});

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<BeginWebhookSecretRotationInput>("""
    {
      "incomingSecretKey": ""
    }
    """);

var result = await api.NotificationsBeginSecretRotationAsync(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/destinations/{id}/secret-rotation/begin");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "incomingSecretKey": ""
    }
    """, 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.BeginWebhookSecretRotationInput.from_dict({
      "incomingSecretKey": ""
    })
    result = api.notifications_begin_secret_rotation("3fa85f64-5717-4562-b3fc-2c963f66afa6", body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "incomingSecretKey": ""
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/notifications/destinations/{id}/secret-rotation/begin",
    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
`incomingSecretKey` required	string	The replacement secret, or null to have the server generate one. nullable

This request body has no documented fields.

Responses

200 OK

Body: BeginWebhookSecretRotationResultDto Each item has these fields.

Field	Type	Description
`incomingSecretKey` required	string	The replacement secret, in plaintext. Shown to the operator once; never returned again. nullable
`state` required	all of WebhookSecretRotationStateDto	The destination's rotation state after the operation.

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

Body: RateLimitProblemDetails Each item has these fields.

Field	Type	Description
`type` required	string	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. nullable
`title` required	string	A short, human-readable summary of the problem type. nullable
`status` required	integer (int32)	The HTTP status code, repeated in the body as the problem-details format defines.
`detail` required	string	A human-readable explanation of this occurrence of the problem. nullable
`retryAfterSeconds` required	integer (int32)	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.

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

Starts a signing-secret rotation.

Example request

Parameters

Request body

Responses

200 OK

429 The request was refused because a rate limit was exceeded. 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.

Errors

Authentication