Skip to main content
POST
Create User Webhook

Authorizations

Authorization
string
header
required

API key must be provided in the Authorization header

Body

application/json
webhook_url
string

HTTPS URL to receive webhook event deliveries; must start with 'https://', have a valid hostname, and be at most 2048 characters.

Example:

"https://example.com/vastai-hook"

event_types
array

List of notification slug strings (e.g. 'low_disk_space' or 'host:low_disk_space') this webhook should receive; must be non-empty and contain only known slugs.

Example:
name
string

Optional human-readable display label for this webhook (max 120 characters, no control characters).

Example:

"My integration"

Response

Success; returns {success: true, webhook: object, enabled_notification_preferences: list}; webhook includes webhook_secret (shown once)

success
boolean

Always true on success.

webhook
object

The created webhook object including id, user_id, name, webhook_url, event_types, created_at, updated_at, and the one-time webhook_secret.

enabled_notification_preferences
string[]

List of preference keys (e.g. 'host:low_disk_space') that were automatically enabled for webhook delivery.