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 ls

Example

pf webhooks list

Create a new webhook

alias: pf wh create

Options

--namestringWebhook name

--urlstringEndpoint URL to receive events

--eventsstringComma-separated list of event types

--disabledbooleanCreate in disabled state

Example

pf webhooks create --name "CI Notify" --url https://ci.example.com/hook --events post.created,post.updated

View webhook details

alias: pf wh show

Example

pf webhooks view wh123

Update a webhook

alias: pf wh update

Options

--namestringNew name

--urlstringNew endpoint URL

--eventsstringNew event types (comma-separated)

--enablebooleanEnable the webhook

--disablebooleanDisable the webhook

Example

pf webhooks edit wh123 --events post.created,comment.created
pf wh update wh123 --disable

Delete a webhook

alias: pf wh rm

Options

--confirmbooleanSkip confirmation prompt

--dry-runbooleanPreview without deleting

Example

pf webhooks delete wh123 --confirm

Send a test event to the webhook endpoint

Example

pf webhooks test wh123

Regenerate the signing secret for a webhook

Options

--confirmbooleanSkip confirmation prompt

--dry-runbooleanPreview without regenerating

Example

pf webhooks regen-secret wh123 --confirm

After regenerating, update the secret in your receiving service. Old signatures will no longer validate.

List recent deliveries for a webhook

alias: pf wh logs

Options

--failedbooleanShow only failed deliveries

Example

pf webhooks deliveries wh123
pf wh logs wh123 --failed

Retry a failed webhook delivery

Example

pf webhooks retry wh123 del456

Poll 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 seconds

Example

pf webhooks listen wh123
pf wh listen wh123 --forward-to http://localhost:3000/api/webhook --events post.created

Useful 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.created

Debugging

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