Skip to content
POST/api/v1/webhooks/{id}/rotate

Rotate a webhook signing secret (dual-sign during grace window)

Generates a new HMAC signing secret for the webhook. During the configurable grace window, outbound deliveries are signed with BOTH the new and previous secrets (header X-EvalGuard-Signature-Previous) so receivers can roll their verifier without dropping events. After the grace window expires, only the new secret is used.

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/settings/api-keys.

Parameters

id in pathrequired
string

Request body

Example

{
  "graceSeconds": 0
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "graceSeconds": {
          "type": "integer",
          "minimum": 0,
          "description": "Seconds the previous secret remains valid for dual-signing after rotation."
        }
      }
    }
  }
}

Response

All status codes

200Rotation succeeded; response includes the new secret value and the previous secret expiry timestamp
400Bad Request — INVALID_ID, VALIDATION_ERROR.
401Unauthorized — no valid credential was presented (AUTH_REQUIRED).
403Forbidden — the credential is valid but lacks the API-key scope, member role, or plan entitlement this operation requires.
404Webhook not found or not in caller org
429Too Many Requests — the per-key or per-organization rate limit was exceeded. Honour the Retry-After header.
500Internal Server Error — DB_ERROR.

Code samples

cURL

# {id} is shown with an EXAMPLE value — replace it with real values.
curl -X POST \
  https://evalguard.ai/api/v1/webhooks/00000000-0000-0000-0000-000000000000/rotate \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "graceSeconds": 0 }'

TypeScript

// The TypeScript SDK (@evalguard/sdk) exposes TYPED methods — runEval,
// getEval, runSecurityScan, checkFirewall, … — not a generic request().
// For an arbitrary endpoint, call it directly:
// {id} is shown with an EXAMPLE value — replace it with real values.

const res = await fetch("https://evalguard.ai/api/v1/webhooks/00000000-0000-0000-0000-000000000000/rotate", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "graceSeconds": 0
  }),
});
console.log(res.status, await res.json());

Python

# The Python SDK (pip install evalguardai) exposes TYPED methods on
# EvalGuardClient — run_eval, get_eval, … — not a generic request().
# For an arbitrary endpoint, call it directly:
# {id} is shown with an EXAMPLE value — replace it with real values.

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['EVALGUARD_API_KEY']}"}
headers["Content-Type"] = "application/json"

response = requests.request(
    "POST",
    "https://evalguard.ai/api/v1/webhooks/00000000-0000-0000-0000-000000000000/rotate",
    headers=headers,
    json={
    "graceSeconds": 0
},
)
print(response.status_code, response.json())

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
	"strings"
)

// {id} is shown with an EXAMPLE value — replace it with real values.
func main() {
	body := strings.NewReader(`{"graceSeconds":0}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/webhooks/00000000-0000-0000-0000-000000000000/rotate", body)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403404429500

Other Webhooks endpoints