Loading documentation…
Loading documentation…
Manage endpoint versions, one-time secrets, pause intervals and retained redrive.
All actions require the owning Customer session and an explicit Project. Workload Credentials only read Events. Read endpoint detail first and use its opaque ETag in If-Match for guarded mutations. A 412 means state changed: refresh, preserve the draft separately and review before resubmitting. Do not silently overwrite a newer configuration.
Pause prevents new subscriptions; older pending work waits and still expires. Resume does not replay pause-interval events. Destination changes require pause and completed in-flight sends, and cancel unsent old-destination obligations. Name/type edits affect future eligibility. Deletion cancels unsent work while retaining inspectable history; an already dispatched request may still complete.
Project archive disables mutations and streaming, suspends endpoints and retains session-readable history. Restoring the Project does not automatically resume endpoints. Correct the suspension reason and explicitly resume where eligible.
Rotation reveals the replacement secret once and retains the previous verification key for a 24-hour overlap. During overlap, attempts carry both signatures. Receivers should accept either recognized configured key, then remove the previous key after its stated expiry and the agreed in-flight allowance. Retry attempts for old events use the current keyset.
A second rotation during overlap is refused. Do not confuse endpoint signing keys with stream cursor keys. A lost secret-reveal response cannot be recovered by a normal GET or repeated reveal. Read the returned key metadata and follow the explicit rotation/recovery path; do not repeatedly rotate without reviewing overlap state.
A test is a separate explicit command. It produces a synthetic delivery with type webhook.test, a stable evt_… ID and data.message equal to SteamCall test delivery. It is not a refresh result or a Customer Activity/SSE event. Tests may run on active or paused endpoints; archive, suspension and deletion prohibit them. Do not interpret a successful test as proof every future delivery will succeed.
Read delivery detail for authoritative redrive_eligibility, endpoint_version and payload_available_until. Eligibility can change before submission. Redrive is available only for failed/expired deliveries with retained payload, an active unchanged endpoint configuration, no unresolved send and fewer than three previous redrives. It preserves the original event/delivery identity and appends attempts under the next redrive ordinal.
Use If-Match and an action-specific Idempotency-Key for test, pause, resume, rotation and redrive. Retry the exact operation with the same key after a lost response. An accepted replay returns the original receipt without scheduling another operation. Creating an endpoint also uses idempotency; PATCH and DELETE use version checks. Redrive can duplicate an already accepted receiver action, so confirm durable deduplication first.
There is no redrive for delivered/cancelled deliveries, deleted destinations, expired payloads or pause-period events without an obligation. A retained metadata row does not guarantee its body is still available. See reference for exact routes and response schemas.