bird webhooks test

bird webhooks test <webhook-id> [flags]

Send a test event

Sends a signed synthetic event to the endpoint's URL and returns the outcome synchronously: whether your endpoint accepted it, the HTTP status it returned, and the round-trip latency. Use it to verify your receiver is reachable and its signature verification is correct. An unreachable endpoint is reported in the response body as status: failed, not as a request error. Your endpoint has 10 seconds to respond.

The test body is a minimal JSON stub carrying only the event type (it does not mirror a real event payload), signed exactly like a real delivery. Test sends go straight to your endpoint: they work on a paused endpoint and are not recorded in List delivery attempts.

A 412 means the endpoint cannot be tested yet: it has no valid signing secret, or no subscribed event types to fall back on when event_type is omitted.

Build the request from flags, a JSON WebhookTestRequest body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

# print the body shape (no credentials needed)
bird webhooks test --example

# the body it prints:

{
  "event_type": "email.delivered"
}