​
Overview

Templates provide pre-configured board structures including groups, columns, automations, and KPI definitions. There are two types: vendor templates shipped with ProBeya (e.g., SQCDP Board, Sprint Board) and tenant templates created by organizations from their existing boards.

​
List Vendor Templates

List all built-in templates provided by ProBeya.

GET /api/trpc/templates.listVendor

Response:

{
  "result": {
    "data": {
      "json": {
        "templates": [
          {
            "id": "tpl_vendor_sqcdp",
            "name": "SQCDP Performance Board",
            "description": "Safety, Quality, Cost, Delivery, People — standard Obeya visual management board with KPI tracking",
            "category": "visual_management",
            "tags": ["probeya", "sqcdp", "kpi", "lean"],
            "preview": "https://probeya.com/templates/sqcdp-preview.png",
            "groups": 5,
            "columns": 8,
            "kpis": 10,
            "automations": 3
          },
          {
            "id": "tpl_vendor_sprint",
            "name": "Agile Sprint Board",
            "description": "Kanban-style sprint board with backlog, in-progress, review, and done columns",
            "category": "agile",
            "tags": ["agile", "scrum", "kanban", "sprint"],
            "preview": "https://probeya.com/templates/sprint-preview.png",
            "groups": 4,
            "columns": 6,
            "kpis": 0,
            "automations": 2
          }
        ]
      }
    }
  }
}

​
List Tenant Templates

List templates created by the current organization.

GET /api/trpc/templates.listTenant

Response:

{
  "result": {
    "data": {
      "json": {
        "templates": [
          {
            "id": "tpl_01HXK5QJBN3YZXM8KJP2RSNV4C",
            "name": "QA Audit Board",
            "description": "Our standard quality audit tracking board",
            "sourceBoardId": "brd_01HXK5...",
            "createdBy": { "id": "usr_01HXK5...", "name": "Alice Johnson" },
            "groups": 3,
            "columns": 7,
            "kpis": 4,
            "automations": 1,
            "usageCount": 12,
            "createdAt": "2026-02-20T10:00:00.000Z"
          }
        ]
      }
    }
  }
}

​
Get Template by ID

Retrieve full template details including structure definition.

GET /api/trpc/templates.getById?input={"json":{"id":"tpl_vendor_sqcdp"}}

Response:

{
  "result": {
    "data": {
      "json": {
        "id": "tpl_vendor_sqcdp",
        "name": "SQCDP Performance Board",
        "description": "Standard Obeya visual management board",
        "structure": {
          "groups": [
            { "name": "Safety", "color": "#ef4444" },
            { "name": "Quality", "color": "#3b82f6" },
            { "name": "Cost", "color": "#f59e0b" },
            { "name": "Delivery", "color": "#22c55e" },
            { "name": "People", "color": "#8b5cf6" }
          ],
          "columns": [
            { "name": "Status", "type": "status" },
            { "name": "Owner", "type": "people" },
            { "name": "Due Date", "type": "date" },
            { "name": "KPI Link", "type": "link" }
          ],
          "kpis": [
            { "name": "Incident Rate", "category": "safety", "unit": "count", "direction": "lower_is_better" },
            { "name": "First Pass Yield", "category": "quality", "unit": "%", "direction": "higher_is_better" }
          ],
          "automations": [
            { "name": "Alert on red KPI", "trigger": { "type": "kpi.threshold_breach" }, "actions": [{ "type": "send_notification" }] }
          ]
        }
      }
    }
  }
}

​
Create Template

Create a tenant template from an existing board.

POST /api/trpc/templates.create

{
  "json": {
    "sourceBoardId": "brd_01HXK5...",
    "name": "QA Audit Board Template",
    "description": "Standard board structure for quarterly quality audits",
    "includeKpis": true,
    "includeAutomations": true
  }
}
FieldTypeRequiredDescription
sourceBoardIdstringYesBoard to snapshot as template
namestringYesTemplate name (1-200 characters)
descriptionstringNoTemplate description
includeKpisbooleanNoInclude KPI definitions (default: true)
includeAutomationsbooleanNoInclude automation rules (default: true)

Template creation captures the board’s structure (groups, columns, KPIs, automations) but not its data (items, values, comments). This is a structural snapshot.

​
Apply Template

Create a new board from a template.

POST /api/trpc/templates.apply

{
  "json": {
    "templateId": "tpl_vendor_sqcdp",
    "projectId": "prj_01HXK5...",
    "boardName": "Q2 2026 SQCDP Board",
    "overrides": {
      "groups": [
        { "name": "Safety", "color": "#dc2626" }
      ]
    }
  }
}
FieldTypeRequiredDescription
templateIdstringYesTemplate to apply
projectIdstringYesTarget project for the new board
boardNamestringYesName for the new board
overridesobjectNoPartial overrides to template structure

​
Update Template

Update template metadata.

POST /api/trpc/templates.update

{
  "json": {
    "id": "tpl_01HXK5...",
    "name": "Updated QA Audit Template",
    "description": "Updated description for the audit template"
  }
}

​
Delete Template

Delete a tenant template. Boards already created from this template are not affected.

POST /api/trpc/templates.delete

{
  "json": {
    "id": "tpl_01HXK5..."
  }
}

Vendor templates cannot be deleted or modified. Only tenant-created templates can be updated or removed.

Was this page helpful?

Automations ExecutionForms