Webhooks with the CLI

The CLI helps you test webhook integrations locally without weakening the production delivery model.

List events

getme webhooks events

Use the event list with the generated Event Catalog to choose event names and inspect payload shape.

Trigger a signed test event

getme webhooks trigger \
  --forward-to http://localhost:3000/webhooks \
  --event booking.cancelled \
  --environment test \
  --secret whsec_test

webhooks trigger sends a signed test event to a local endpoint. It is useful for handler development and CI smoke checks.

Listen and forward

getme webhooks listen \
  --forward-to http://localhost:3000/webhooks \
  --port 4242 \
  --secret whsec_...

webhooks listen accepts local webhook requests and forwards the original signed request to your application. When --secret is provided, the CLI verifies X-Getme-Signature before forwarding.

Test and live payloads

Local trigger defaults to --environment test, which creates payloads with livemode: false. Pass --environment live only when you intentionally need a live-shaped local fixture. Keep the signing secret separate from any real live endpoint secret.

Handler rules

Webhook handlers should:

• read the raw request body for signature verification;
• verify X-Getme-Signature before processing;
• handle duplicate deliveries idempotently;
• respond with a 2xx status only after the event is safely accepted.