Webhooks

Disable a webhook endpoint

Pauses delivery to an enabled endpoint: no new deliveries are created and queued ones are not attempted while it is disabled. The signing secret and configuration are kept. On re-enable, subscribed events from the paused window that are at most seven days old are delivered automatically; use webhook.endpoint.recover for anything older.

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}/disable

Request

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

Response

Success

tenantIdstring required

Organization tenant ID

webhookEndpointIdstring required

Hyperscale outbound webhook endpoint ID

updatedAtstring date-time required
reasonstring required
previousStatus'enabled' required
status'disabled' required

Changes

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