Cancel a waiting or paused firing
const url = 'https://api.pixonaut.app/v1/automations/example/firings/example/cancel';const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.pixonaut.app/v1/automations/example/firings/example/cancel \ --header 'Authorization: Bearer <token>'Operation ID: automations.firings.cancel
It stops where it is and does nothing more.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Responses
Section titled “Responses”The firing as it is now
object
object
The automation whose action set it off; null when nobody’s did.
object
What the automation was called when it acted.
How many firings deep it is, from 1.
The event that started the chain.
The event that set it off.
object
Why it failed, paused or was cancelled, in Pixonaut’s words. For an MCP key, a reason that may carry a printshop’s own answer (an email’s or a printshop step’s) is replaced: it can name the order’s customer.
The step it got to, and that step’s reason; null before any. For an MCP key, a reason that may carry a printshop’s own answer (an email’s or a printshop step’s) is replaced: it can name the order’s customer.
object
Every step of its version, in order, branches after their step; one it never got to is not_reached.
object
The branches it sits in, from the top; empty for a step of the body itself.
When it is tried again, while it is retrying.
For an MCP key, a reason that may carry a printshop’s own answer (an email’s or a printshop step’s) is replaced: it can name the order’s customer.
object
The email it would have sent, done in a sandbox, which sends no email to anyone who is not a member; null otherwise, and for an MCP key.
object
False when its texts name a customer’s personal data, which a firing never keeps: subject and text are then as written.
When it stops waiting, while it waits.
What it acts on, by id.
object
The name of the template its design was made from, which is how a design is named; null once the design is gone.
Every design, print file and order id it touched.
The version it runs on.
Examples
Example
{ "chain": { "causedBy": null, "depth": 1, "rootEventId": "evt_5a1c9e7b2d4f" }, "event": { "at": 1760000300000, "id": "evt_5a1c9e7b2d4f", "type": "design.committed" }, "finishedAt": 1760000440000, "id": "fir_1a2b3c4d5e6f", "manualActions": [ { "action": "cancelled", "at": 1760000440000, "by": { "kind": "member", "name": "Ada Lewis", "userId": "u_8b1d2c3e4f5a" } } ], "ranAs": { "kind": "member", "name": "Ada Lewis", "userId": "u_8b1d2c3e4f5a" }, "reason": "Ada Lewis cancelled it.", "startedAt": 1760000300000, "state": "cancelled", "step": { "reason": "It reached its limit of 50 spend actions in 24 hours.", "state": "paused", "stepId": "order", "type": "place_order" }, "steps": [ { "at": 1760000310000, "attempts": 1, "branch": [], "label": null, "nextTryAt": null, "reason": null, "state": "done", "stepId": "print", "subjects": { "designId": "des_2b4d8a9f6c1e", "printId": "prt_9e1b3d5f7a2c" }, "type": "create_print", "unsent": null, "waitingUntil": null }, { "at": 1760000320000, "attempts": 1, "branch": [], "label": "Order one copy", "nextTryAt": null, "reason": "It reached its limit of 50 spend actions in 24 hours.", "state": "paused", "stepId": "order", "subjects": { "printId": "prt_9e1b3d5f7a2c" }, "type": "place_order", "unsent": null, "waitingUntil": null }, { "at": null, "attempts": 0, "branch": [ "onFailure" ], "label": null, "nextTryAt": null, "reason": null, "state": "not_reached", "stepId": "tell", "subjects": {}, "type": "notify", "unsent": null, "waitingUntil": null } ], "subject": { "designId": "des_2b4d8a9f6c1e", "orderId": "ord_6c1d2e3f4a5b", "printId": "prt_9e1b3d5f7a2c", "templateName": "Classic Tee" }, "touched": [ "des_2b4d8a9f6c1e", "prt_9e1b3d5f7a2c", "ord_6c1d2e3f4a5b" ], "version": 3}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: unauthorized
object
Examples
unauthorized
{ "error": "unauthorized"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: feature_disabled, origin_forbidden, forbidden
object
The feature the tenant does not have. Always sent with feature_disabled.
Examples
feature_disabled
{ "error": "feature_disabled", "feature": "api"}forbidden
{ "error": "forbidden"}origin_forbidden
{ "error": "origin_forbidden"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: automation_not_found, firing_not_found
object
Examples
automation_not_found
{ "error": "automation_not_found"}firing_not_found
{ "error": "firing_not_found"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: firing_control_refused
object
Always sent with firing_control_refused.
Examples
firing_control_refused
{ "error": "firing_control_refused", "reason": "string"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: payload_too_large
object
Always sent with payload_too_large.
Examples
payload_too_large
{ "error": "payload_too_large", "maxBytes": 0}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: db_error. A request that failed unexpectedly answers as text instead.
object
Examples
db_error
{ "error": "db_error"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Questions? Write to [email protected].