Rotate the signing secret
POST/v1/webhooks/{webhookId}/rotate-secret
Returns the new secret once. For gracePeriodSeconds (0 to 86,400, default 86,400) every request is signed with both the new and the previous secret, then only the new one. Send 0 to stop signing with the previous secret at once, for example after it leaked.
Request
curl -s -X POST $BLITFRAME/webhooks/ce9bfd3d-fceb-4655-8821-2e3f7ce0b101/rotate-secret \
-H "Authorization: Bearer $BLITFRAME_API_KEY" \
-H "Content-Type: application/json" \
-d '{"gracePeriodSeconds": 0}'
import os, requests
response = requests.post(
f"{os.environ['BLITFRAME']}/webhooks/ce9bfd3d-fceb-4655-8821-2e3f7ce0b101/rotate-secret",
headers={"Authorization": f"Bearer {os.environ['BLITFRAME_API_KEY']}"},
json={"gracePeriodSeconds": 0},
)
print(response.json())
const response = await fetch(`${process.env.BLITFRAME}/webhooks/ce9bfd3d-fceb-4655-8821-2e3f7ce0b101/rotate-secret`, {
method: "POST",
headers: { Authorization: `Bearer ${process.env.BLITFRAME_API_KEY}`, "Content-Type": "application/json" },
body: JSON.stringify({ gracePeriodSeconds: 0 }),
});
console.log(await response.json());
<?php
$request = curl_init(getenv("BLITFRAME") . "/webhooks/ce9bfd3d-fceb-4655-8821-2e3f7ce0b101/rotate-secret");
curl_setopt_array($request, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("BLITFRAME_API_KEY"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => '{"gracePeriodSeconds": 0}',
]);
$response = curl_exec($request);
echo $response;
require "net/http"
uri = URI(ENV["BLITFRAME"] + '/webhooks/ce9bfd3d-fceb-4655-8821-2e3f7ce0b101/rotate-secret')
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer " + ENV["BLITFRAME_API_KEY"]
request["Content-Type"] = "application/json"
request.body = '{"gracePeriodSeconds": 0}'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| http.request(request) }
puts response.body
package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{"gracePeriodSeconds": 0}`)
request, err := http.NewRequest("POST", os.Getenv("BLITFRAME")+"/webhooks/ce9bfd3d-fceb-4655-8821-2e3f7ce0b101/rotate-secret", body)
if err != nil {
panic(err)
}
request.Header.Set("Authorization", "Bearer "+os.Getenv("BLITFRAME_API_KEY"))
request.Header.Set("Content-Type", "application/json")
response, err := http.DefaultClient.Do(request)
if err != nil {
panic(err)
}
defer response.Body.Close()
text, _ := io.ReadAll(response.Body)
fmt.Println(string(text))
}
using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post,
Environment.GetEnvironmentVariable("BLITFRAME") + "/webhooks/ce9bfd3d-fceb-4655-8821-2e3f7ce0b101/rotate-secret");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("BLITFRAME_API_KEY"));
request.Content = new StringContent(
"""
{"gracePeriodSeconds": 0}
""", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
var request = HttpRequest.newBuilder(URI.create(System.getenv("BLITFRAME") + "/webhooks/ce9bfd3d-fceb-4655-8821-2e3f7ce0b101/rotate-secret"))
.header("Authorization", "Bearer " + System.getenv("BLITFRAME_API_KEY"))
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("""
{"gracePeriodSeconds": 0}
"""))
.build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
Path parameters
webhookIdstring (uuid)required
Headers
AuthorizationBearer Blitframe API keyrequiredAPI key from the developer console.
Body
application/json · optional · RotateWebhookSecretRequest or null
gracePeriodSecondsinteger or null
Responses
- 200 OK
application/json · WebhookSecretDto
secretstringpreviousSecretExpiresAtstring (date-time) or null
Errors
- 400 Bad Request
- 401 Unauthorized
- 404 Not Found
- 429 Too Many Requests
application/json · ErrorResponse
errorApiErrorApiError fields
codestringmessagestring
Errors lists the error codes and says when to retry.