CLI: webhook
Complete help for farthershore webhook and every subcommand.
farthershore webhook
Usage: farthershore webhook [options] [command]
Manage outbound webhook endpoints
Options:
-h, --help display help for command
Commands:
list [options] [businessIdOrSlug] List API-managed webhook endpoints
create [options] [businessIdOrSlug] Create an API-managed webhook endpoint
update [options] [businessIdOrSlug] [webhookId] Update a webhook endpoint's URL, events, environment or enabled state
delete [options] [businessIdOrSlug] [webhookId] Delete an API-managed webhook endpoint. Requires --yes.
test [options] [businessIdOrSlug] [webhookId] Send a signed test event to a webhook endpoint
trigger [options] [businessIdOrSlug] [webhookId] Send a signed sample of a specific event (e.g. payment.failed) to a webhook endpoint
listen [options] [businessIdOrSlug] Tunnel platform webhooks to a local receiver and tail deliveries until Ctrl-C
rotate [options] [businessIdOrSlug] [webhookId] Issue a new signing secret (returned once); the old one keeps verifying for 24h
event-types [businessIdOrSlug] List the event names a webhook endpoint can subscribe to
deliveries [options] [businessIdOrSlug] [webhookId] List recent delivery attempts for a webhook endpoint
help [command] display help for command
farthershore webhook list
Usage: farthershore webhook list [options] [businessIdOrSlug]
List API-managed webhook endpoints
Options:
--limit <n> Max rows to return.
-h, --help display help for command
farthershore webhook create
Usage: farthershore webhook create [options] [businessIdOrSlug]
Create an API-managed webhook endpoint
Options:
--url <url> HTTPS receiver URL.
--events <events> Comma-separated event names, e.g.
subscription.created,payment.failed
--env <environmentId> Only deliver events from this environment (default:
every environment).
--idempotency-key <key> Required for this mutation. Generate it once and
reuse the exact value on retry.
-h, --help display help for command
farthershore webhook update
Usage: farthershore webhook update [options] [businessIdOrSlug] <webhookId>
Update a webhook endpoint's URL, events, environment or enabled state
Options:
--url <url> Replacement HTTPS receiver URL.
--events <events> Comma-separated event names, e.g.
subscription.created,payment.failed
--env <environmentId> Only deliver events from this environment.
--all-envs Clear the environment scope: deliver events from every
environment again.
--enable Enable delivery for this endpoint.
--disable Disable delivery for this endpoint.
-h, --help display help for command
farthershore webhook delete
Usage: farthershore webhook delete [options] [businessIdOrSlug] <webhookId>
Delete an API-managed webhook endpoint. Requires --yes.
Options:
--yes Skip confirmation; required for this destructive action
-h, --help display help for command
farthershore webhook test
Usage: farthershore webhook test [options] [businessIdOrSlug] <webhookId>
Send a signed test event to a webhook endpoint
Options:
--idempotency-key <key> Required for this mutation. Generate it once and
reuse the exact value on retry.
-h, --help display help for command
farthershore webhook trigger
Usage: farthershore webhook trigger [options] [businessIdOrSlug] <webhookId>
Send a signed sample of a specific event (e.g. payment.failed) to a webhook
endpoint
Options:
--type <event> Envelope type to send: one of subscription.created,
subscription.updated, subscription.canceled,
payment.succeeded, payment.failed,
entitlement.changed, usage.threshold_reached,
webhook.test. A catalog event is delivered with a
realistic sample payload.
--idempotency-key <key> Required for this mutation. Generate it once and
reuse the exact value on retry.
-h, --help display help for command
farthershore webhook listen
Usage: farthershore webhook listen [options] [businessIdOrSlug]
Tunnel platform webhooks to a local receiver and tail deliveries until Ctrl-C
Options:
--forward-to <localUrl> Local receiver URL, e.g.
http://localhost:3000/webhooks/farthershore
--events <events> Comma-separated event names to subscribe (default:
every catalog event)
--print-secret Print the temporary endpoint's FS_WEBHOOK_SECRET so
the local receiver can verify signatures
--trigger <event> Fire a signed sample of this event as soon as the
tunnel is up
-h, --help display help for command
Requires cloudflared: bundled via the @farthershore/cloudflared-<platform>
optional dependency, or a `cloudflared` on PATH. Ctrl-C deletes the
temporary endpoint; a killed listener leaves a *.trycloudflare.com endpoint
that `farthershore webhook delete <business> <webhookId> --yes` removes.
Examples:
farthershore webhook listen acme --forward-to http://localhost:3000/webhooks --print-secret
farthershore webhook listen acme --forward-to localhost:3000/webhooks --events payment.failed --trigger payment.failed
farthershore webhook rotate
Usage: farthershore webhook rotate [options] [businessIdOrSlug] <webhookId>
Issue a new signing secret (returned once); the old one keeps verifying for 24h
Options:
--idempotency-key <key> Required for this mutation. Generate it once and
reuse the exact value on retry.
-h, --help display help for command
farthershore webhook event-types
Usage: farthershore webhook event-types [options] [businessIdOrSlug]
List the event names a webhook endpoint can subscribe to
Options:
-h, --help display help for command
farthershore webhook deliveries
Usage: farthershore webhook deliveries [options] [businessIdOrSlug] <webhookId>
List recent delivery attempts for a webhook endpoint
Options:
--limit <n> Max rows to return.
-h, --help display help for command