Skip to content

Rotate webhook secret

POST/webhook-endpoints/{id}/rotate-secret

Issue a new secret. Both secrets sign for 24 hours.

Sandbox: test money only. No request moves real money.

Authenticate with your sandbox key as a bearer token: Authorization: Bearer nbk_test_....

Note. The answer carries the endpoint's signing secret, shown once: store it now. A replay with the same Idempotency-Key never returns it. Verifying a delivery shows how a receiver checks a signature with it.

Request

HeaderValueSent
AuthorizationBearer nbk_test_...Required
Idempotency-Key3f1c9a52-7d4e-4b8a-9c21-5e6f7a8b9c0dOptional

Parameters

FieldDescription
IDid · path string · requiredPattern ^whe_[0-9A-HJKMNP-TV-Z]{26}$.
Idempotency keyIdempotency-Key · header stringBound permanently, in the database, to what the first request made (a quote, an endpoint, a rotation, a delivery replay), as a money operation's key is: a retry with the same key and request answers 200 with Idempotent-Replayed: true and repeats nothing, and the same key with another request or on another operation is 422 idempotency_key_reused. A replay never returns a secret. Without a key, every request is performed. Pattern ^[A-Za-z0-9_-]{16,64}$.
The request in cURL, JavaScript and Python
POST /v1/webhook-endpoints/{id}/rotate-secretSandbox, test key
const response = await fetch('https://sandbox-api.nasfampay.com/v1/webhook-endpoints/whe_01K7SAMP000000000000000001/rotate-secret', {  method: 'POST',  headers: {    Authorization: `Bearer ${process.env.NASFAM_SANDBOX_KEY}`,  },});if (!response.ok) {  const problem = await response.json();  throw new Error(`${problem.status} ${problem.code}: ${problem.title} (request ${problem.request_id})`);}const result = await response.json();console.log(response.status, result);
Code for Request
POST /v1/webhook-endpoints/{id}/rotate-secretSandbox, test key
// npm install axiosimport axios from 'axios';try {  const { status, data: endpoint } = await axios.post(    'https://sandbox-api.nasfampay.com/v1/webhook-endpoints/whe_01K7SAMP000000000000000090/rotate-secret',    null,    {      headers: {        Authorization: `Bearer ${process.env.NASFAM_SANDBOX_KEY}`,      },    },  );  console.log(status, endpoint);} catch (error) {  if (!axios.isAxiosError(error) || !error.response) throw error;  const problem = error.response.data;  throw new Error(`${problem.status} ${problem.code}: ${problem.title} (request ${problem.request_id})`);}

Responses

StatusMeaningBody
OK200Rotated: the new secret, in this response only. A replay of an earlier request with the same Idempotency-Key (Idempotent-Replayed: true) is the endpoint as it is now and no secret; nothing is rotated again. Headers: RateLimit (draft-ietf-httpapi-ratelimit-headers-11. the same buckets, each "<bucket>";r=<whole requests remaining, never negative>;t=<seconds until the quota is fully available again>. ), RateLimit-Policy (draft-ietf-httpapi-ratelimit-headers-11. a structured field list with one item per bucket the request drew on (orders, quotes, quotes_daily, reads, webhooks, lookups, lookups_org, lookups_daily), each "<bucket>";q=<quota>;w=<window seconds>. no partition key (pk) is sent. ), Idempotent-Replayed.WebhookEndpointRotation object
Too many requests429Too many requests (rate_limited), or your queued orders are at your cap (queue_limit). A bucket that cannot be read at once because of contention is answered here too, never waited on. Honour Retry-After. . Headers: Request-Id, Retry-After (seconds to wait before retrying), RateLimit (draft-ietf-httpapi-ratelimit-headers-11. the same buckets, each "<bucket>";r=<whole requests remaining, never negative>;t=<seconds until the quota is fully available again>. ), RateLimit-Policy (draft-ietf-httpapi-ratelimit-headers-11. a structured field list with one item per bucket the request drew on (orders, quotes, quotes_daily, reads, webhooks, lookups, lookups_org, lookups_daily), each "<bucket>";q=<quota>;w=<window seconds>. no partition key (pk) is sent. ).Problem object
Any other statusdefaultError (RFC 9457). A 503 service_unavailable with Retry-After means the request was not processed: the rate limiter or the database could not answer, and the API refuses rather than serve unlimited (reads included). For a money-moving operation, retrying with the same Idempotency-Key is always safe. . Headers: Request-Id, Retry-After (on 429 and some 503 responses).Problem object

The webhook endpoint rotation object

FieldDescription
IDid · string · requiredPattern ^whe_[0-9A-HJKMNP-TV-Z]{26}$.
URLurl · string · required
Eventsevents · array of EventType · requiredEach one of order.accepted, order.processing, order.succeeded, order.failed, order.refunded, order.under_review, funding.credited, deposit.confirmed, balance.low, balance.recovered.
Descriptiondescription · string or null
Enabledenabled · boolean · required
Disabled reasondisabled_reason · string or nullKnown values: repeated_failures, gone_410.
Created atcreated_at · string · requiredFormat date-time.
Secretsecret · stringThe new secret, shown once. Absent from a replay (Idempotent-Replayed: true). Pattern ^whsec_[A-Za-z0-9+/=]{43,88}$.

Responses are extensible: ignore fields, enum values and event types you do not know. Any other status is a Problem (see Errors).

Every kind of response
200 OKSynthetic sandbox data
{  "secret": "whsec_EXAMPLExNOTxAxSECRETxEXAMPLExNOTxAxSECRETxEXAMPL",  "id": "whe_01K7SAMP000000000000000001",  "url": "https://example.com/webhooks/nasfam",  "events": [    "order.accepted"  ],  "description": null,  "enabled": true,  "disabled_reason": null,  "created_at": "2026-10-10T10:05:02Z"}
Code for Responses
Response
JSON
200 OKSynthetic sandbox data
{  "id": "whe_01K7SAMP000000000000000090",  "url": "https://example.com/webhooks/nasfam",  "events": [    "order.succeeded",    "order.failed",    "order.under_review",    "funding.credited"  ],  "description": "Order updates",  "enabled": true,  "disabled_reason": null,  "created_at": "2026-10-10T10:12:00.000Z",  "secret": "whsec_ROTATEDxEXAMPLExNOTxAxSECRETxROTATEDxEXAMPLExNOT"}
Error
JSON
429 Too Many RequestsSynthetic sandbox data
{  "type": "about:blank",  "title": "Too many requests",  "status": 429,  "code": "rate_limited",  "category": "rate_limit",  "detail": "Too many requests. Retry after the time in Retry-After.",  "param": null,  "request_id": "req_01K7SAMP000000000000000090"}

How it behaves

What to expect
AuthenticationYour key as a bearer token in the Authorization header: a nbk_test_ key on the sandbox host.
IdempotencyOptional. Sent, it is bound permanently to what the first request made, and a retry repeats nothing.
In the sandboxServed, on your own test records.
On LiveThe same request, on the Live host with a live key, which exists only for a workspace activated for Live. See Go live.
FundingNone. This request does not touch your balance.
Status changesBoth secrets sign for 24 hours.
Webhook eventsNone.

Error responses

This operation can also answer with not_found, idempotency_key_reused.

Any request can answer with invalid_request, invalid_api_key, key_expired, key_environment_mismatch, insufficient_scope, rate_limited, service_unavailable, internal_error. Errors says what to do about each one.