Webhooks

Update a webhook endpoint

Updates an endpoint's delivery URL, enabled event set, or description. The signing secret and product scope never change here: rotate the secret with webhook.endpoint.secret.rotate, and create a new endpoint to target a different product. The new URL must satisfy the same host policy as create (HTTPS in live, no private or loopback addresses). Deleted endpoints are terminal and cannot be updated.

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

patch/v1/webhook-endpoints/{webhookEndpointId}

Request

  • Base URL: https://hyperscale0.ai
  • URL: https://hyperscale0.ai/v1/webhook-endpoints/{webhookEndpointId}
  • 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

Request body

reasonstring required
urlstring
descriptionstring nullable

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
reasonstring required

Changes

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