SnozeDevelopers
API referenceAutomations

Enable an automation

Turns the automation on and returns it; an automation that has never been published is published first, since publishing is what makes it live. Requires the `automations:write` permission plus edit access; an already-enabled automation is returned unchanged, and the publish path still enforces its preconditions, so an empty or invalid graph is rejected with a validation error. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.

POST
/v1/workspaces/{workspaceId}/automations/{automationId}/enable

Authorization

apiKey
AuthorizationBearer <token>

Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.

In: header

Path Parameters

workspaceId*string
automationId*string

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/v1/workspaces/string/automations/string/enable"
{  "data": {    "id": "string",    "workspaceId": "string",    "key": "string",    "label": "string",    "enabled": true,    "versionId": "string",    "version": 0,    "publishedVersionId": "string",    "draftVersionId": "string",    "hasUnpublishedChanges": true,    "trigger": "manual",    "triggerConfig": {      "kind": "manual"    },    "graph": {      "nodes": [        {          "id": "string",          "label": "string",          "retry": {            "maxAttempts": 0,            "initialDelaySeconds": 0,            "backoffMultiplier": 0,            "maxDelaySeconds": 0          },          "position": {            "x": 0,            "y": 0          },          "kind": "action",          "actionId": "string",          "input": {            "property1": {              "type": "literal",              "value": null            },            "property2": {              "type": "literal",              "value": null            }          }        }      ],      "edges": [        {          "id": "string",          "from": "string",          "to": "string",          "outcome": "always"        }      ],      "entryNodeIds": [        "string"      ],      "testPayloads": [        {          "id": "string",          "name": "string",          "payload": {}        }      ],      "failureAutomationId": "string",      "triggerPosition": {        "x": 0,        "y": 0      }    },    "webhookPath": "string",    "webhookSecret": "string",    "nextRunAt": "string",    "lastTriggeredAt": "string",    "createdAt": "string",    "updatedAt": "string",    "referenceIssues": [      {        "nodeId": "string",        "message": "string"      }    ]  }}

Delete an automation

Deletes the automation together with the workspace item that represents it, and records the deletion in the workspace event ledger. Requires the `automations:write` permission plus edit access; an unknown id returns not-found. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.

Disable an automation

Turns the automation off so its published triggers stop firing, and returns it. Requires the `automations:write` permission plus edit access; an automation that is already disabled is returned unchanged. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.