bird webhooks test

Usage

Esempio di codice

bird webhooks test <webhook-id> [flags]

Send a signed synthetic event and get the outcome synchronously: whether the endpoint accepted, the HTTP status it returned, and the round-trip latency. An unreachable endpoint comes back as a failed status in the body rather than a request error. The receiver has 10 seconds, the body is a minimal stub carrying only the event type, and a test reaches even a paused endpoint without being recorded in the delivery attempts.

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.

Examples

Esempio di codice

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

# the body it prints:

Esempio di codice

{
  "event_type": "email.delivered"
}

Options

Event

Name	Description
--event-type	Event type to simulate. Any type from the event catalog is accepted, whether or not the endpoint subscribes to it; an unknown type returns a 422. When omitted, the endpoint's first subscribed event type is used.

Request

Name	Description
--body-file	Read the JSON request body from this file; "-" reads stdin
--example	Print a complete example request body, then exit
--dry-run	Print the resolved request without sending it, then exit
--idempotency-key	Deduplication key; a retry with the same key won't act twice

Options

Name	Description
--response-schema	Print the fields this command returns, then exit

Name	Description
bird webhooks attempts	List delivery attempts
bird webhooks create	Create a webhook endpoint
bird webhooks delete	Delete a webhook endpoint
bird webhooks get	Get a webhook endpoint
bird webhooks list	List webhook endpoints
bird webhooks rotate-secret	Rotate webhook signing secret