Webhooks

Rotate a webhook endpoint signing secret

Creates a new webhook signing secret, returns it exactly once, and keeps the prior secret valid for 24 hours so in-flight deliveries continue to verify.

Needs a Product key made in the browser. A key made from a CLI login or an agent token cannot call this operation.

post/v1/webhook-endpoints/{webhookEndpointId}/secret/rotate

Request

  • Base URL: https://hyperscale0.ai
  • URL: https://hyperscale0.ai/v1/webhook-endpoints/{webhookEndpointId}/secret/rotate
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

webhookEndpointIdstring required

Hyperscale outbound webhook endpoint ID

Headers

X-Hyperscale-Environment'sandbox' | 'live'
Idempotency-Keystring required

Response

Success

tenantIdstring required

Organization tenant ID

webhookEndpointIdstring required

Hyperscale outbound webhook endpoint ID

productIdstring required

Hyperscale product ID

urlstring required
status'deleted' | 'disabled' | 'enabled' required
audience'entity' | 'tenant' required
entityAccountIdstring nullable required

Hyperscale account ID

secretLast4string required
descriptionstring nullable required
lastDeliveryStatus'exhausted' | 'failed' | 'pending' | 'succeeded' nullable required
lastDeliveryAtstring date-time nullable required
createdAtstring date-time required
updatedAtstring date-time required
signingSecretstring

One-time replacement signing secret surfaced only in the first response; receipts and replays omit it

previousSecretExpiresAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.