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

API reference

Automation

GET/api/v1/events/recent

The latest events, newest first: the polling twin of the live stream.

CLI
sendmock events tail
MCP tool
sendmock_events_recent
In the app
Notification bell

Answer

200 AppEvent[]

Try it in Demo mode

GET/api/v1/integrations/{stack}

Copy-ready settings for a stack, as Settings > Connection shows them.

CLI
sendmock integrate <stack>
MCP tool
sendmock_integration_snippet
In the app
Settings > Connection

Answer

200 IntegrationSnippet

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

Try it in Demo mode

POST/api/v1/scenarios/validate

Check a scenario file without running it.

CLI
sendmock scenario validate <file>
MCP tool
sendmock_scenario_validate
In the app
Scenarios > Validate

Request body (application/json)

ScenarioRequest : Body of POST /api/v1/scenarios/validate and /run: a scenario file's TOML text.

FieldTypeDescription
scenariostring
The scenario file's text, in TOML.Example: name = "otp-login" [[steps]] run = "sample.send" with = { kind = "sms" }

Answer

200 ScenarioValidation

Try it in Demo mode

POST/api/v1/scenarios/run

Run a scenario file step by step and report each step.

CLI
sendmock scenario run <file>
MCP tool
sendmock_scenario_run
In the app
Scenarios > Run

Request body (application/json)

ScenarioRequest : Body of POST /api/v1/scenarios/validate and /run: a scenario file's TOML text.

FieldTypeDescription
scenariostring
The scenario file's text, in TOML.Example: name = "otp-login" [[steps]] run = "sample.send" with = { kind = "sms" }

Answer

200 ScenarioReport

Errors: 422, as { error: { code, message } }

Try it in Demo mode

GET/api/v1/ai/skill

The SendMock agent skill as Markdown.

CLI
sendmock ai skill
MCP tool
sendmock://docs/skill
In the app
Settings > Connection > AI agents > Download the skill

Answer

200 string (text/markdown)

Try it in Demo mode