deeprelayDocs
CH·02CLI reference

deeprelay webhooks create

Register a webhook endpoint

Register a webhook endpoint

Synopsis

Registers an HTTPS endpoint and subscribes it to an explicit list of event types. The response includes the HMAC signing secret — it is shown ONCE and cannot be retrieved later, so store it before moving on. Neither deeprelay webhooks get nor deeprelay webhooks list will ever return it; if you lose it, delete the endpoint and register a new one.

--events accepts these six event types (repeat the flag or pass a comma-separated list):

  • video.completed
  • video.failed
  • balance.low — the wallet balance fell below your alert threshold
  • subscription_quota.threshold — a subscription allowance reached 80% or 100%
  • api_key_budget.threshold — an API key reached 80% or 100% of its monthly budget
  • member_spend.threshold — a member reached 80%, 95% or 100% of their spending limit

Each alert event fires once per crossing. See Webhooks for the payloads.

There is no all shortcut — subscriptions are explicit, so an endpoint never silently starts receiving event types added later.

Examples

# Comma-separated list of event types
deeprelay webhooks create --url https://example.com/hooks/deeprelay --events balance.low,api_key_budget.threshold

# Same thing with a repeated flag
deeprelay webhooks create --url https://example.com/hooks/deeprelay \
  --events video.completed \
  --events video.failed

deeprelay webhooks create [flags]

Options

      --events strings   Event type to subscribe to (required; may repeat or be comma-separated). One of: video.completed, video.failed, balance.low, subscription_quota.threshold, api_key_budget.threshold, member_spend.threshold, plan_roster.model_removed
  -h, --help             help for create
      --url string       HTTPS URL to deliver events to (required)

Options inherited from parent commands

      --api-base string   API base URL (override with DEEPRELAY_API_BASE env) (default "https://api.deeprelay.ai/v1")
      --debug             Enable debug logging to stderr
      --no-preflight      Skip the plan/credit check before inference requests (override with DEEPRELAY_NO_PREFLIGHT env)
  -o, --output string     Output format: table|json (default table on TTY, json otherwise) (default "table")

SEE ALSO

← The deeprelay CLI