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

API reference

Saved deliveries

POST/api/v1/webhooks/saved

Save a delivery's request under a name.

CLI
sendmock webhook saved create --delivery <deliveryId>
MCP tool
sendmock_webhook_saved_create
In the app
Webhooks > Deliveries > delivery > Save

Request body (application/json)

SavedDeliveryInput : Body of POST /api/v1/webhooks/saved.

FieldTypeDescription
namestring
A name for the saved delivery.Example: Failed order webhook
delivery_idUlid
The delivery to save.Example: 01JB7T9Q2R5W8X3Y6Z1A4B7C9D

Answer

201 SavedDelivery

Errors: 400, 404, 409, as { error: { code, message } }

Try it in Demo mode

PATCH/api/v1/webhooks/saved/{savedId}

Rename a saved delivery.

CLI
sendmock webhook saved rename <savedId>
MCP tool
sendmock_webhook_saved_update
In the app
Webhooks > Saved > Rename

Request body (application/json)

SavedDeliveryRename : Body of PATCH /api/v1/webhooks/saved/{savedId}.

FieldTypeDescription
namestring
The new name.Example: Order webhook, missing SKU

Answer

200 SavedDelivery

Errors: 400, 404, as { error: { code, message } }

Try it in Demo mode

POST/api/v1/webhooks/saved/{savedId}/send

Send a saved request to its endpoint or another one.

CLI
sendmock webhook saved send <savedId>
MCP tool
sendmock_webhook_saved_send
In the app
Webhooks > Saved > Send

Request body (application/json)

SavedDeliverySendRequest : Body of POST /api/v1/webhooks/saved/{savedId}/send.

FieldTypeDescription
endpoint_idUlid
The endpoint to send it to.Example: 01JB7T9Q2R5W8X3Y6Z1A4B7C9D
rerenderboolean
Renders again with the endpoint's template and variables; false sends the saved request as it was.Example: false

Answer

200 WebhookDelivery

Errors: 400, 404, as { error: { code, message } }

Try it in Demo mode

POST/api/v1/webhooks/saved/{savedId}/template

Turn a saved request into a custom template.

CLI
sendmock webhook saved save-as-template <savedId>
MCP tool
sendmock_webhook_saved_save_as_template
In the app
Webhooks > Saved > Save as template

Request body (application/json)

SaveAsTemplateRequest : Body of POST /api/v1/webhooks/saved/{savedId}/template.

FieldTypeDescription
namestring
The name of the new custom template.Example: Order webhook

Answer

201 WebhookTemplateSummary

Errors: 400, 404, as { error: { code, message } }

Try it in Demo mode