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 one of six event types (repeat the flag or pass a comma-separated list):

  • instance.creating
  • instance.running
  • instance.terminated
  • instance.failed
  • video.completed
  • video.failed
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 instance.running,instance.failed

# 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
  -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 gpu CLI