PgBeam Docs
webhooks

webhooks test

Send a test delivery to a webhook endpoint

Trigger a test delivery to a webhook endpoint to verify its URL, format, and signing secret are configured correctly. PgBeam sends a sample payload and reports the result.

Usage

pgbeam webhooks test <id>

Options

OptionDescriptionRequiredDefault
<id>ID of the webhook endpoint to testYes-

Global options

All global options (--token, --profile, --project, --org, --json, --no-color, --debug) are also available on this command.

Examples

# Send a test delivery
pgbeam webhooks test wh_xxx

# Send a test delivery and get the result as JSON
pgbeam webhooks test wh_xxx --json

Output

Prints a success message confirming the test delivery was sent. With --json, returns the test result from the API.

On this page