webhooks
webhooks create
Create a webhook endpoint
Create a webhook endpoint for the linked project. PgBeam delivers event and audit notifications to the given URL using the selected format. Subscribe to specific event types with --event (repeatable or comma-separated); omit it to receive all events.
Usage
pgbeam webhooks create [url] [flags]Options
| Option | Description | Required | Default |
|---|---|---|---|
<url> | Destination URL for webhook deliveries. If omitted, you will be prompted. | No | - |
--format <value> | Delivery format: json, splunk_hec, datadog, or elastic. | No | json |
--event <value> | Event type(s) to subscribe to. Comma-separated. Omit to receive all events. | No | - |
--secret <value> | Shared secret used to sign webhook payloads. | No | - |
--description <value> | Human-readable description for the webhook endpoint. | No | - |
--disabled | Create the webhook in a disabled state. | No | false |
Global options
All global options (--token, --profile,
--project, --org, --json, --no-color, --debug) are also available on
this command.
Examples
# Create a webhook interactively
pgbeam webhooks create
# Create a webhook for a URL
pgbeam webhooks create https://example.com/hook
# Create a Datadog webhook for specific events
pgbeam webhooks create https://example.com/hook --format datadog --event query.blocked,policy.updated
# Create a disabled webhook with a secret
pgbeam webhooks create https://example.com/hook --secret s3cr3t --disabledOutput
Prints a success message with the new webhook ID and its URL. With --json, returns the full webhook object from the API.