Preview: SendMock has no stable release yet. These docs follow develop.

CLI reference

Webhook deliveries commands

sendmock webhook deliveries cancel

Stop the remaining retries.

sendmock webhook deliveries cancel <deliveryId>
ArgumentTypeDescription
<deliveryId>requiredstring
The webhook delivery's ID, from GET /api/v1/webhooks/deliveries.Example: 01JB7T9Q2R5W8X3Y6Z1A4B7C9D

Example

sendmock webhook deliveries cancel 01JB7T9Q2R5W8X3Y6Z1A4B7C9D

Output with --json: WebhookDeliveryDetail. Exit codes: 0, 1, 2, 3.

API
POST/api/v1/webhooks/deliveries/{deliveryId}/cancel
MCP tool
sendmock_webhook_delivery_cancel
In the app
Webhooks > Deliveries > delivery > Cancel retries

sendmock webhook deliveries list

Every webhook request sent, newest first.

sendmock webhook deliveries list [flags]
FlagTypeDescription
--cursor <cursor>string
The next_cursor of the previous page.Example: 01JB7T9Q2R5W8X3Y6Z1A4B7C9D
--limit <limit>integer
Items per page, 1 to 200 (default 50).Example: 50
--status <status>string
succeeded, failed or pending.Example: failed
--endpoint-id <endpoint-id>string
Only this endpoint.Example: 01JB7T9Q2R5W8X3Y6Z1A4B7C9D
--event-type <event-type>string
Only this event.One of: email.received, email.inbound, email.opened, email.clicked, email.delivered, email.deferred, email.bounced, email.complained, email.unsubscribed, email.released, email.deleted, sms.sent, sms.status, sms.opened, sms.inbound, sms.reply_webhook, verify.started, verify.checked, verify.expired, push.sent, push.failed, http.captured, payment.created, payment.authorized, payment.succeeded, payment.failed, payment.canceled, payment.refunded, payment.partially_refunded, payment.dispute_opened, payment.dispute_updated, payment.dispute_closed, checkout.completed, checkout.expired, subscription.created, subscription.renewed, subscription.payment_failed, subscription.canceled, webhook.delivered, webhook.failed, test.ping, traffic.prunedExample: email.received
--subject-id <subject-id>string
Only the deliveries an email, SMS or other message caused, by its ID.Example: 01JB7T9Q2R5W8X3Y6Z1A4B7C9E

Example

sendmock webhook deliveries list --cursor 01JB7T9Q2R5W8X3Y6Z1A4B7C9D --limit 50

Output with --json: PageOf_WebhookDelivery. Exit codes: 0, 1, 2.

API
GET/api/v1/webhooks/deliveries
MCP tool
sendmock_webhook_delivery_list
In the app
Webhooks > Deliveries

sendmock webhook deliveries replay

Send the delivery again, as it was or edited.

sendmock webhook deliveries replay <deliveryId> [flags]
ArgumentTypeDescription
<deliveryId>requiredstring
The webhook delivery's ID, from GET /api/v1/webhooks/deliveries.Example: 01JB7T9Q2R5W8X3Y6Z1A4B7C9D
FlagTypeDescription
--rerenderrequiredboolean
Renders the request again with today's template and variables; false resends the stored request as it was. --no-rerender sets it to false.
--body <body>string
An edited body and headers; left out to resend the stored request.Example: {"type": "email.received"}
--headers <headers>object (JSON)
Edited headers, by name; left out to resend the stored ones.

Example

sendmock webhook deliveries replay 01JB7T9Q2R5W8X3Y6Z1A4B7C9D --no-rerender --body '{"type": "email.received"}'

Output with --json: WebhookDelivery. Exit codes: 0, 1, 2, 3.

API
POST/api/v1/webhooks/deliveries/{deliveryId}/replay
MCP tool
sendmock_webhook_delivery_replay
In the app
Webhooks > Deliveries > delivery > Replay, Edit and replay

sendmock webhook deliveries show

One delivery: request, response and every attempt.

sendmock webhook deliveries show <deliveryId>
ArgumentTypeDescription
<deliveryId>requiredstring
The webhook delivery's ID, from GET /api/v1/webhooks/deliveries.Example: 01JB7T9Q2R5W8X3Y6Z1A4B7C9D

Example

sendmock webhook deliveries show 01JB7T9Q2R5W8X3Y6Z1A4B7C9D

Output with --json: WebhookDeliveryDetail. Exit codes: 0, 1, 2, 3.

API
GET/api/v1/webhooks/deliveries/{deliveryId}
MCP tool
sendmock_webhook_delivery_get
In the app
Webhooks > Deliveries > open a delivery

sendmock webhook metrics

Volume, success rate, latency and failures over a range.

sendmock webhook metrics [flags]
FlagTypeDescription
--range <range>requiredstring
24h or 7d.One of: 24h, 7dExample: 24h
--endpoint-id <endpoint-id>string
Only this endpoint.Example: 01JB7T9Q2R5W8X3Y6Z1A4B7C9D

Example

sendmock webhook metrics --range 24h

Output with --json: WebhookMetrics. Exit codes: 0, 1, 2.

API
GET/api/v1/webhooks/metrics
MCP tool
sendmock_webhook_metrics
In the app
Webhooks > Overview