Skip to content

CLI reference

ry webhooks

Markdown

Endpoints we call when a message is sent, bounces, is complained about, fails or arrives.

ry webhooks [options] [command]

Your webhooks with the answer of their last delivery.

ry webhooks list [options]

Example:

ry webhooks list

Register an https endpoint; prints the signing secret exactly once.

ry webhooks add [options] <url>

Options:

  • -e, --events <list>: Comma-separated events (sent, delivered, delivery_delayed, bounced, complained, failed, received), or all. Default: all.

Example:

ry webhooks add https://www.example.com/hooks/rytiv

The last deliveries to one endpoint, newest first.

ry webhooks deliveries [options] <id>

Options:

  • -n, --limit <n>: How many entries (control plane caps at 500). Default: 50.

Example:

ry webhooks deliveries wh-1a2b3c4d

Delete a webhook; pending deliveries are dropped.

ry webhooks remove [options] <id>

Options:

  • -y, --yes: Skip confirmation (required for automation).

Example:

ry webhooks remove wh-1a2b3c4d