Rotate a Partner webhook signing secret
curl --request POST \
--url https://api.stabyl.com/v1/partner/webhooks/{webhook_id}/secret/rotate \
--header 'X-Api-Key: <api-key>'import requests
url = "https://api.stabyl.com/v1/partner/webhooks/{webhook_id}/secret/rotate"
headers = {"X-Api-Key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://api.stabyl.com/v1/partner/webhooks/{webhook_id}/secret/rotate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.stabyl.com/v1/partner/webhooks/{webhook_id}/secret/rotate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.stabyl.com/v1/partner/webhooks/{webhook_id}/secret/rotate"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.stabyl.com/v1/partner/webhooks/{webhook_id}/secret/rotate")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stabyl.com/v1/partner/webhooks/{webhook_id}/secret/rotate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"previous_secret_valid_until": "2026-07-13T11:00:00Z",
"secret": "whsec_<new-shown-once>",
"secret_version": 2,
"webhook_id": "01980d95-5537-76aa-88a8-ad59117632ef"
},
"status": "success"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "missing X-Api-Key header"
},
"status": "error"
}{
"error": {
"code": "MISSING_SCOPE",
"message": "missing_scope"
},
"status": "error"
}{
"error": {
"code": "NOT_FOUND",
"message": "resource not found"
},
"status": "error"
}{
"error": {
"code": "SECRET_ROTATION_IN_PROGRESS",
"message": "secret_rotation_in_progress"
},
"status": "error"
}{
"error": {
"code": "PARTNER_WEBHOOKS_DISABLED",
"message": "partner_webhooks_disabled"
},
"status": "error"
}Webhooks
Rotate a Partner webhook signing secret
Generates and returns a new Standard Webhooks secret exactly once. The previous secret remains valid only for the configured overlap; a second rotation during overlap returns 409.
POST
/
partner
/
webhooks
/
{webhook_id}
/
secret
/
rotate
Rotate a Partner webhook signing secret
curl --request POST \
--url https://api.stabyl.com/v1/partner/webhooks/{webhook_id}/secret/rotate \
--header 'X-Api-Key: <api-key>'import requests
url = "https://api.stabyl.com/v1/partner/webhooks/{webhook_id}/secret/rotate"
headers = {"X-Api-Key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://api.stabyl.com/v1/partner/webhooks/{webhook_id}/secret/rotate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.stabyl.com/v1/partner/webhooks/{webhook_id}/secret/rotate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.stabyl.com/v1/partner/webhooks/{webhook_id}/secret/rotate"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.stabyl.com/v1/partner/webhooks/{webhook_id}/secret/rotate")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stabyl.com/v1/partner/webhooks/{webhook_id}/secret/rotate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"previous_secret_valid_until": "2026-07-13T11:00:00Z",
"secret": "whsec_<new-shown-once>",
"secret_version": 2,
"webhook_id": "01980d95-5537-76aa-88a8-ad59117632ef"
},
"status": "success"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "missing X-Api-Key header"
},
"status": "error"
}{
"error": {
"code": "MISSING_SCOPE",
"message": "missing_scope"
},
"status": "error"
}{
"error": {
"code": "NOT_FOUND",
"message": "resource not found"
},
"status": "error"
}{
"error": {
"code": "SECRET_ROTATION_IN_PROGRESS",
"message": "secret_rotation_in_progress"
},
"status": "error"
}{
"error": {
"code": "PARTNER_WEBHOOKS_DISABLED",
"message": "partner_webhooks_disabled"
},
"status": "error"
}Authorizations
API credential. Withdrawal quote and submit operations additionally require the documented Ed25519 timestamp, nonce, and signature headers.
Path Parameters
Webhook endpoint identifier
Was this page helpful?
⌘I