Webhooks

Create a webhook endpoint

Registers an outbound webhook endpoint for one Product's audit-event delivery and returns the signing secret exactly once in the create response. Sandbox accepts http URLs and live endpoints must use HTTPS. Both refuse loopback and private hosts.

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

Request

  • Base URL: https://hyperscale0.ai
  • URL: https://hyperscale0.ai/v1/webhook-endpoints
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Headers

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

Request body

urlstring required
descriptionstring
productIdstring required

Product whose attributed events this endpoint receives.

entityAccountIdstring

Deliver only events naming this account, to a channel for the end customer who owns it. Omit for the Product's own webhook.

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 signing secret surfaced only in the first response; receipts and replays omit it

Changes

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