Namespace Reference

Workflow and automation

Curated JQL namespaces and examples for workflow and automation.

Workflow and automation namespaces describe reusable workflow templates, node templates, automation events, jobs, logs, queues, and playground runs.

Key namespaces and models

  • workflow.TemplateGroup
  • workflow.Template
  • workflow.NodeTemplate
  • workflow.NodeTemplateSection
  • workflow.NodeTemplateQuestion
  • automation.Event
  • automation.Template
  • automation.Job
  • automation.JobLog
  • automation.WorkflowAutomationQueue
  • automation.Playground

Common controller intents

  • workflow.Template.saveNodes
  • workflow.Template.clearNodes
  • workflow.Template.updateNode
  • workflow.NodeTemplate.saveQuestion
  • automation.Automation.getNamespaces
  • automation.Automation.getNamespaceEvents
  • automation.Automation.getNamespaceAttributesV3
  • automation.Automation.getActions
  • automation.Automation.saveAutomationTemplate
  • automation.Automation.processZapierAction

Common model intents

Most listed model namespaces support retrieve, retrieveOne, retrieveV2, create, update/patch, deleteOne, metadata, and aggregate subject to model permissions. Use consequence only for models that implement an on_<consequence> hook.

Retrieve example

json
1{ 2 "__meta__": { 3 "schema": "model", 4 "namespace": "automation.Job", 5 "intent": "retrieve", 6 "authenticationClass": "jwt", 7 "ordering": "-created", 8 "limit": 20 9 }, 10 "id": null, 11 "created": null 12}

Create example

json
1{ 2 "__meta__": { 3 "schema": "model", 4 "namespace": "workflow.TemplateGroup", 5 "intent": "create", 6 "authenticationClass": "jwt", 7 "return": { 8 "id": null, 9 "name": null, 10 "alias": null 11 } 12 }, 13 "name": "Ticket workflows", 14 "alias": "ticket-workflows" 15}

For examples that include foreign keys, numeric ids must refer to records in the same tenant and visible to the authenticated user.