Workspace automations overview

Workspace automations are rule graphs that run across a workspace.

The workspace automation object

Attributes

• actor_id string (uuid)

  The related actor.

• automation_edge_id string (uuid)

  The related automation edge.

• automation_id string (uuid)

  The related automation.

• automation_node_id string (uuid)

  The related automation node.

• automation_run_id string (uuid)

  The related automation run.

• automation_scope string

  The automation scope.

• automation_version_id string (uuid)

  The related automation version.

• created_at string (date-time)

  When the record was created.

• epoch number

  The epoch.

• field string

  The field.

• id string (uuid)

  Unique identifier.

• new_identifier string (uuid)

  The new identifier.

• new_value string

  The new value.

• node_execution_id string (uuid)

  The related node execution.

• old_identifier string (uuid)

  The old identifier.

• old_value string

  The old value.

• verb string

  The verb.

Response200

{
  "actor_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "automation_edge_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "automation_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "automation_node_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "automation_run_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "automation_scope": "example",
  "automation_version_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "created_at": "2026-01-14T09:22:41.478363Z",
  "epoch": 1,
  "field": "example",
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "new_identifier": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "new_value": "example",
  "node_execution_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "old_identifier": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "old_value": "example",
  "verb": "example"
}

Endpoints

Method	Path	Description
GET	/api/v2/workspaces/{slug}/automations/{automation_id}/activities/	List automation activities
GET	/api/v2/workspaces/{slug}/automations/{automation_id}/edges/	List automation edges
GET	/api/v2/workspaces/{slug}/automations/{automation_id}/nodes/	List automation nodes
GET	/api/v2/workspaces/{slug}/automations/	List workspace automations
GET	/api/v2/workspaces/{slug}/automations/{automation_id}/activities/{pk}/	Get an automation activity
GET	/api/v2/workspaces/{slug}/automations/{automation_id}/edges/{pk}/	Get an automation edge
GET	/api/v2/workspaces/{slug}/automations/{automation_id}/nodes/{pk}/	Get an automation node
GET	/api/v2/workspaces/{slug}/automations/{pk}/	Get a workspace automation
POST	/api/v2/workspaces/{slug}/automations/{automation_id}/edges/	Create an automation edge
POST	/api/v2/workspaces/{slug}/automations/{automation_id}/nodes/	Create an automation node
POST	/api/v2/workspaces/{slug}/automations/	Create a workspace automation
PATCH	/api/v2/workspaces/{slug}/automations/{automation_id}/edges/{pk}/	Update an automation edge
PATCH	/api/v2/workspaces/{slug}/automations/{automation_id}/nodes/{pk}/	Update an automation node
PATCH	/api/v2/workspaces/{slug}/automations/{pk}/	Update a workspace automation
DELETE	/api/v2/workspaces/{slug}/automations/{automation_id}/edges/{pk}/	Delete an automation edge
DELETE	/api/v2/workspaces/{slug}/automations/{automation_id}/nodes/{pk}/	Delete an automation node
DELETE	/api/v2/workspaces/{slug}/automations/{pk}/	Delete a workspace automation
POST	/api/v2/workspaces/{slug}/automations/{automation_id}/nodes/{pk}/regenerate-webhook-secret/	Regenerate an automation node webhook secret
POST	/api/v2/workspaces/{slug}/automations/{pk}/status/	Enable or disable a workspace automation

Response shaping

Every workspace automation read accepts ?fields= for sparse responses — see Sparse fields. Errors follow the shared problem+json contract.