Send a test of the whole automation
Send a test copy of every email step at once to the team member who created the API key, and to nobody else: the request names no recipient.
https://app.usenotix.dev/api/v1/automations/{id}/testNeeds a full access key. Sending access keys cannot call this. Key permissions lists the extra rules some calls have.
Send a test copy of every email step at once to the team member who created the API key, and to nobody else: the request names no recipient. Waits are skipped. Each copy is marked [Test], costs nothing, honours suppression and uses one of the team's hourly test sends. Needs a full access key; a key made before Notix recorded who made each key answers 403. The key's creator can run 5 tests a minute.
Path parameters
Headers
Bearer followed by your API key.
Errors
The journey has no email, or more emails than the team's hourly test sends, or none could be sent.
`SCOPE_DENIED`: not a full access key. `FORBIDDEN`: the key has no recorded creator.
No journey with this id for the calling team (or, for a pinned key, on its domain).
The key's creator ran 5 tests in the last minute, or the team's hourly test sends are used up.
Every error has the same shape. See all error codes.
curl -X POST "https://app.usenotix.dev/api/v1/automations/<id>/test" \
-H "Authorization: Bearer $NOTIX_API_KEY"
import { Notix } from "notix-js";
const notix = new Notix(process.env.NOTIX_API_KEY);
const { data, error } = await notix.journeys.testRun("jrn_123");
console.log(`${data?.sent} of ${data?.total} sent to ${data?.recipient}`);
{
"sent": 1,
"total": 1,
"recipient": "string",
"failed": [
{
"subject": "Your receipt for order 4471",
"reason": "string"
}
]
}