bird webhooks create

Usage

Contoh kode

bird webhooks create <url> [flags]

Register an HTTPS endpoint to receive this workspace's events, subscribed to the event types in events and active immediately. The response is the only place the signing secret appears, and it can never be read back afterward, only rotated.

Build the request from the <url> argument and flags, a JSON WebhookEndpointCreate body via --body-file ("-" reads stdin), or both — an inline value 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

Contoh kode

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

# the body it prints:

Contoh kode

{
  "description": "Production delivery + bounce notifications",
  "events": ["email.delivered", "email.bounced"],
  "url": "https://example.com/webhooks/bird"
}

Options

Endpoint

Name	Description
--events <v1,v2,…>	Event types to subscribe to; the endpoint receives only matching events. Types outside the event catalog return a 422, and an endpoint holds at most 100 entries.
--description	Human-readable label for this endpoint, up to 256 characters.

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 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
bird webhooks test	Send a test event