/
Webhooks
Create, test, and monitor webhooks from the command line. Webhooks are a Pro plan feature. Alias: pf wh
Commands
List all webhooks
alias: pf wh lsExample
pf webhooks listCreate a new webhook
alias: pf wh createOptions
--namestringWebhook name--urlstringEndpoint URL to receive events--eventsstringComma-separated list of event types--disabledbooleanCreate in disabled stateExample
pf webhooks create --name "CI Notify" --url https://ci.example.com/hook --events post.created,post.updatedView webhook details
alias: pf wh showExample
pf webhooks view wh123Update a webhook
alias: pf wh updateOptions
--namestringNew name--urlstringNew endpoint URL--eventsstringNew event types (comma-separated)--enablebooleanEnable the webhook--disablebooleanDisable the webhookExample
pf webhooks edit wh123 --events post.created,comment.created
pf wh update wh123 --disableDelete a webhook
alias: pf wh rmOptions
--confirmbooleanSkip confirmation prompt--dry-runbooleanPreview without deletingExample
pf webhooks delete wh123 --confirmSend a test event to the webhook endpoint
Example
pf webhooks test wh123Regenerate the signing secret for a webhook
Options
--confirmbooleanSkip confirmation prompt--dry-runbooleanPreview without regeneratingExample
pf webhooks regen-secret wh123 --confirmAfter regenerating, update the secret in your receiving service. Old signatures will no longer validate.
List recent deliveries for a webhook
alias: pf wh logsOptions
--failedbooleanShow only failed deliveriesExample
pf webhooks deliveries wh123
pf wh logs wh123 --failedRetry a failed webhook delivery
Example
pf webhooks retry wh123 del456Poll for new deliveries in real-time. Optionally forward payloads to a local endpoint.
Options
--forward-tostringLocal URL to forward payloads to--eventsstringFilter by event types--intervalnumberPolling interval in secondsExample
pf webhooks listen wh123
pf wh listen wh123 --forward-to http://localhost:3000/api/webhook --events post.createdUseful for local development. Press Ctrl+C to stop listening.
Local Development
Use pf webhooks listen to forward webhook events to your local development server. This lets you test webhook integrations without exposing your machine to the internet.
# Forward all events to your local server
pf webhooks listen wh123 --forward-to http://localhost:3000/api/webhook
# Only forward specific events
pf webhooks listen wh123 --forward-to http://localhost:3000/api/webhook --events post.created,comment.createdDebugging
Check delivery history and retry failed deliveries:
# View failed deliveries
pf webhooks deliveries wh123 --failed
# Retry a specific delivery
pf webhooks retry wh123 del456
# Send a test event
pf webhooks test wh123