rotatePersistentAgentWebhookSecret
POST/agents/:id/webhooks/:webhookId/rotate-secret
Replace the outbound webhook signing secret immediately and return the new value. The sender does not provide a dual-secret grace period. Requires agents:manage. Optional protected retries require API_EXTENDED_RETRIES_ENABLED for new admissions; retained retries survive disabling admission. Original outcomes expire after 24 hours by default; current authority is rechecked. Task creation requires wait to be omitted. Secret rotation retries conflict if superseded.
Request
Responses
- 200
- 400
- 403
- 404
- 409
- 429
- 500
- 503
Response Headers
Smaller configured principal/owner request window limit when enforcement is enabled.
Smaller remaining principal/owner allowance at admission.
Seconds until the Redis-server-time fixed request window resets.
Opaque retained receipt ID. Outcome lookup is available for covered G02 member and allowed G01 service operations.
Original protected response expiry.
Present when Idempotency-Key is used: false for the original response, true for a replay.
Server-generated synchronous HTTP correlation; no worker lineage implied.
Invalid request body or query parameters. Field errors may be returned as arrays.
Response Headers
Server-generated synchronous HTTP correlation; no worker lineage implied.
Missing/invalid API key, insufficient scope, account eligibility, or communication policy denial.
Response Headers
Server-generated synchronous HTTP correlation; no worker lineage implied.
Resource not found or not accessible to this API key.
Response Headers
Server-generated synchronous HTTP correlation; no worker lineage implied.
Idempotency key reused for a different request, or an incompatible resource state.
Response Headers
Server-generated synchronous HTTP correlation; no worker lineage implied.
request_quota_exceeded or wait_capacity_exceeded. Honor Retry-After; no new input was accepted.
Response Headers
Seconds until the suggested retry, not a readiness guarantee.
Server-generated synchronous HTTP correlation; no worker lineage implied.
Unexpected failure; JSON includes detail and an error_id for support.
Response Headers
Server-generated synchronous HTTP correlation; no worker lineage implied.
admission_unavailable or work_capacity_exceeded. Honor Retry-After and preserve protected-write keys.
Response Headers
Seconds until the suggested retry, not a readiness guarantee.
Server-generated synchronous HTTP correlation; no worker lineage implied.