dsc webhook¶

Manage outbound Discourse webhooks with an administrator API key.

dsc webhook list¶

dsc webhook list <discourse> [--format text|json|yaml]

Lists every configured webhook, following Discourse pagination. Output includes the ID, URL, state, delivery status, scopes, tags, and event types. Webhook signing secrets are never printed, and URL userinfo, query parameters, and fragments are redacted.

dsc webhook create¶

dsc webhook create <discourse> <payload_url> [--content-type json|form] [--secret-stdin] [--inactive] [--no-verify-certificate] [--format text|json|yaml]

Creates an active wildcard webhook by default. dsc attaches Discourse's default event types, so the new webhook receives normal event deliveries. Per-event selection is not yet supported.

The payload URL must be an absolute HTTP or HTTPS URL. To configure a signing secret, pipe it to --secret-stdin; it must contain at least 12 characters and cannot be blank. This avoids shell-history and process-list exposure. Neither the secret nor URL userinfo, query parameters, or fragments appear in normal or dry-run output.

printf %s "$WEBHOOK_SECRET" | dsc webhook create myforum https://hooks.example.test/discourse --secret-stdin

dsc webhook delete¶

dsc webhook delete <discourse> <webhook_id> [--format text|json|yaml]

Deletes a webhook by positive numeric ID.

dsc webhook ping¶

dsc webhook ping <discourse> <webhook_id> [--format text|json|yaml]

Enqueues Discourse's test ping event for a webhook. It is a real delivery and therefore honours global --dry-run.

All mutating subcommands print a complete [dry-run] plan without modifying the forum when invoked with -n or --dry-run. webhook create makes one read-only request to discover and show the exact default event types it would attach.