Hyperscale docs Sign in Start building

Create a webhook endpoint

webhook.endpoint.create

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.

POST /v1/webhook-endpoints

Scopes: webhook:write

Input

FieldTypeDescription
url requiredstring
enabledEvents requiredobject[]
descriptionstring
productId requiredstringProduct whose attributed events this endpoint receives.
entityAccountIdstringDeliver only events naming this account, to a channel for the end customer who owns it. Omit for the Product's own webhook.
idempotencyKey requiredstringNew per change; reuse only to retry it.

Request sample

curl --request POST 'https://console.hyperscale0.ai/v1/webhook-endpoints' \
  --header "Authorization: Bearer $HYPERSCALE_API_KEY" \
  --header 'X-Hyperscale-Environment: sandbox' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "url": "<string>",
  "enabledEvents": "<object[]>",
  "productId": "<string>",
  "idempotencyKey": "<string>"
}'

All operations