Shared Steps
Create and manage reusable named test snippets via the Smoketest API.
Shared Steps are project-scoped reusable markdown snippets. In the app, users insert them into tests from the slash menu as chips. In stored markdown, a chip is represented as a stable link token:
[Log in](smoketest-shared-step:018effff-abcd-7000-8000-abc123456789)Shared Steps cannot reference other Shared Steps yet. A Shared Step cannot be deleted while any Test references it.
The Shared Step object
{
"id": "018effff-abcd-7000-8000-abc123456789",
"name": "Log in",
"description": "Open login, enter credentials, submit, and verify the dashboard.",
"referencedTestCount": 2,
"createdAt": "2026-06-09T12:00:00.000Z",
"updatedAt": "2026-06-09T12:30:00.000Z"
}| Field | Type | Description |
|---|---|---|
id | UUID | Unique identifier |
name | string | Display name, unique within the project |
description | string | Markdown-backed reusable steps |
referencedTestCount | number | Number of Tests that reference this Shared Step |
createdAt | ISO 8601 | Creation timestamp |
updatedAt | ISO 8601 | Last updated timestamp |
List Shared Steps
curl "https://api.smoketest.sh/v1/projects/018e5678-abcd-7000-8000-abc123456789/shared-steps" \
-H "Authorization: Bearer $SMOKETEST_API_KEY"Create a Shared Step
curl -X POST "https://api.smoketest.sh/v1/projects/018e5678-abcd-7000-8000-abc123456789/shared-steps" \
-H "Authorization: Bearer $SMOKETEST_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Log in",
"description": "Open login, enter credentials, submit, and verify the dashboard."
}'Get, update, or delete a Shared Step
curl "https://api.smoketest.sh/v1/shared-steps/018effff-abcd-7000-8000-abc123456789" \
-H "Authorization: Bearer $SMOKETEST_API_KEY"Update a Shared Step:
curl -X PATCH "https://api.smoketest.sh/v1/shared-steps/018effff-abcd-7000-8000-abc123456789" \
-H "Authorization: Bearer $SMOKETEST_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "description": "Open login, enter credentials, submit, and verify the dashboard nav." }'Delete a Shared Step:
curl -X DELETE "https://api.smoketest.sh/v1/shared-steps/018effff-abcd-7000-8000-abc123456789" \
-H "Authorization: Bearer $SMOKETEST_API_KEY"