Rotate the signing secret
Replaces the signing secret and returns the new one in the clear, once (secret). The old secret stops verifying immediately: every attempt from now on — retries of events queued before the rotation included — is signed with the new one. A delivery your receiver refuses in the switch-over is retried on the normal schedule, so a receiver that answers non-2xx to a bad signature and picks up the new secret within minutes loses nothing.
Request
- Base URL: https://api.imagestep.dev
- URL: https://api.imagestep.dev/api/v1/webhook-endpoints/{id}/rotate-secret
- Auth: API key in header Authorization
Path parameters
The endpoint's id (whe_…), as create and the listing return it
Headers
Optional. A client-generated unique key (typically a UUID). Same key + the same request (method, path, query string and body) replays the first response verbatim with Idempotency-Replayed: true, without executing again. Same key + a different one returns 409 idempotency_key_reuse. A repeat that arrives while the first is still running returns 409 request_in_progress, which is retryable. Keys are retained 24 hours. At most 255 characters; a longer one is a 400 invalid_param with param: "Idempotency-Key".
Response
The endpoint, with the new secret in the clear
Changes
No recorded changes to this operation across all 1 revision of this API.