envshed webhook
Manage webhooks for an organization. Webhooks deliver HTTP POST requests to a target URL when events occur (e.g. secrets are pushed or deleted). Requires admin or owner role.
Service tokens cannot manage webhooks. All webhook commands require a user token.
webhook list
envshed webhook list [options]
Lists all webhooks for the organization.
Options
| Option | Description |
|---|---|
-o, --org <slug> | Organization slug |
--output json | Print JSON output |
webhook create
envshed webhook create [options]
Creates a new webhook. For custom endpoints, a CSPRNG-generated signing secret is displayed once at creation time: save it immediately. Slack and Discord webhooks get no signing secret, since they can't check it.
Options
| Option | Description |
|---|---|
--name <name> | Webhook name (required) |
--url <url> | Target URL, must be HTTPS (required) |
--events <events> | Comma-separated event groups (required). See Events |
--type <type> | Webhook type (default: http) |
-o, --org <slug> | Organization slug |
--output json | Print JSON output |
Events
| Value | Sends on |
|---|---|
* | Every change, including kinds of change added later |
changed (or push) | Secrets added or changed: add, edit, import, push from the CLI, copy or promote, roll back, restore a snapshot, turn into a placeholder |
deleted (or delete) | Secrets deleted, one or many at once |
toggled (or disable, enable) | Secrets turned off or on |
Single action names such as secret.update are also accepted and stored as their group. An unknown name is refused.
webhook update
envshed webhook update <id> [options]
Updates an existing webhook. At least one option must be provided.
Options
| Option | Description |
|---|---|
--name <name> | New webhook name |
--url <url> | New target URL |
--events <events> | New comma-separated event groups. See Events |
--active / --no-active | Enable or disable the webhook |
-o, --org <slug> | Organization slug |
--output json | Print JSON output |
webhook delete
envshed webhook delete <id> [options]
Deletes a webhook. Prompts for confirmation unless --yes is passed.
Options
| Option | Description |
|---|---|
-o, --org <slug> | Organization slug |
-y, --yes | Skip confirmation prompt |
--output json | Print JSON output |
webhook test
envshed webhook test <id> [options]
Sends a test webhook.test event to the webhook URL and shows the HTTP response status and latency. The response body is never shown.
Options
| Option | Description |
|---|---|
-o, --org <slug> | Organization slug |
--output json | Print { "status": N, "latency_ms": N } |
Verify deliveries
The X-Envshed-Signature header has the format t=<unix-seconds>,v1=<hex-hmac>.
X-Envshed-Timestamp carries the same timestamp. Compute HMAC-SHA256 using your
signing secret over the exact string <timestamp>.<raw-request-body> and compare
in constant time. Reject deliveries whose timestamp is more than five minutes
old or in the future. Use the raw body before JSON parsing. Body-only signatures
from older releases are no longer emitted.