Deployments.ai Docs
Command reference

deployments webhook

Signed semantic webhooks

CommandSummary
deployments webhook createCreate a webhook subscription
deployments webhook listList webhook subscriptions
deployments webhook showShow a webhook subscription
deployments webhook archiveArchive a webhook subscription
deployments webhook updateUpdate a webhook subscription
deployments webhook disablePause deliveries to a webhook subscription
deployments webhook enableResume deliveries to a webhook subscription
deployments webhook rotate-secretRotate a webhook signing secret
deployments webhook testSend a signed test event to a webhook subscription

deployments webhook create

Create a webhook subscription.

deployments webhook create --name <name> --url <url> --event-types <a-b-c>
  • Calls POST /v1/webhooks (SDK createWebhook).
  • Needs an environment: --env or the saved context.
  • Output contains secrets. They are redacted unless you pass --reveal.
FlagTypeRequiredDefaultDescription
--namestringyesResource name
--urlstringyesHTTPS endpoint URL
--event-typesstring (a,b,c)yesSemantic event types
--resource-filtersstring (json)Resource filter JSON

Also accepts the global flags.

deployments webhook list

List webhook subscriptions.

deployments webhook list
  • Calls GET /v1/webhooks (SDK listWebhooks).
  • Needs an environment: --env or the saved context.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size

Also accepts the global flags.

deployments webhook show

Show a webhook subscription.

deployments webhook show <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments webhook archive

Archive a webhook subscription.

deployments webhook archive <id>
  • Calls POST /v1/webhooks/{webhookId}/archive (SDK archiveWebhook).
  • Needs an environment: --env or the saved context.
  • Destructive. Live runs ask for confirmation; pass --yes in scripts or with --json.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments webhook update

Update a webhook subscription.

deployments webhook update <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--namestringWebhook subscription name
--urlstringHTTPS endpoint URL
--event-typesstring (a,b,c)Semantic event types
--resource-filtersstring (json)Resource filter JSON
--clear-resource-filtersbooleanRemove all resource filters

Also accepts the global flags.

deployments webhook disable

Pause deliveries to a webhook subscription.

deployments webhook disable <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments webhook enable

Resume deliveries to a webhook subscription.

deployments webhook enable <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments webhook rotate-secret

Rotate a webhook signing secret.

deployments webhook rotate-secret <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--previous-secret-expires-in-secondsstring (number)Seconds the previous secret keeps signing (0 to 604800, default 86400)

Also accepts the global flags.

deployments webhook test

Send a signed test event to a webhook subscription.

deployments webhook test <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

On this page