Examples

Example 1: Create a Bug Issue from an Error Alert Webhook

Scenario: A monitoring platform (e.g. PagerDuty, Datadog, or a custom alerting system) sends a webhook to BizFirst when a production error is detected. Automatically create a prioritised Jira bug with full context.

{
  "Resource": "issue",
  "Operation": "create",
  "ProjectKey": "{{ env.JIRA_ENG_PROJECT_KEY }}",
  "IssueType": "Bug",
  "Summary": "[{{ vars.severity }}] {{ vars.service_name }}: {{ vars.error_type }} — {{ vars.environment }}",
  "Description": {
    "version": 1,
    "type": "doc",
    "content": [
      {
        "type": "paragraph",
        "content": [{ "type": "text", "text": "Auto-created by BizFirst monitoring workflow." }]
      },
      {
        "type": "heading", "attrs": { "level": 3 },
        "content": [{ "type": "text", "text": "Error Details" }]
      },
      {
        "type": "codeBlock", "attrs": { "language": "text" },
        "content": [{ "type": "text", "text": "{{ vars.error_message }}\n\n{{ vars.stack_trace }}" }]
      },
      {
        "type": "heading", "attrs": { "level": 3 },
        "content": [{ "type": "text", "text": "Context" }]
      },
      {
        "type": "bulletList",
        "content": [
          { "type": "listItem", "content": [{ "type": "paragraph", "content": [{ "type": "text", "text": "Service: {{ vars.service_name }}" }] }] },
          { "type": "listItem", "content": [{ "type": "paragraph", "content": [{ "type": "text", "text": "Environment: {{ vars.environment }}" }] }] },
          { "type": "listItem", "content": [{ "type": "paragraph", "content": [{ "type": "text", "text": "Alert ID: {{ vars.alert_id }}" }] }] },
          { "type": "listItem", "content": [{ "type": "paragraph", "content": [{ "type": "text", "text": "Dashboard: {{ vars.dashboard_url }}" }] }] }
        ]
      }
    ]
  },
  "Priority": "{{ vars.jira_priority }}",
  "Assignee": "{{ vars.oncall_jira_account_id }}",
  "Labels": ["{{ vars.environment }}", "{{ vars.service_name }}", "auto-created"],
  "Components": ["{{ vars.service_component }}"]
}

Example 2: Search for All Open Bugs in the Current Sprint Using JQL

Scenario: A daily stand-up preparation workflow queries all open, unassigned bugs in the active sprint and posts a summary to the engineering Slack channel before the meeting.

{
  "Resource": "issue",
  "Operation": "getMany",
  "Jql": "project = {{ env.JIRA_ENG_PROJECT_KEY }} AND issuetype = Bug AND status != Done AND sprint in openSprints() ORDER BY priority DESC, created ASC",
  "MaxResults": 50,
  "Fields": "summary,status,priority,assignee,labels,created,updated"
}

Example 3: Transition Issue to "In Review" When a PR is Opened

Scenario: A GitHub webhook triggers when a developer opens a pull request. The PR title or branch name includes a Jira issue key. Automatically move the issue from "In Progress" to "In Review" to reflect the actual work state.

Step 1 — Extract the Jira issue key from the PR branch name using a DataMapping node:

// Expression to extract issue key from branch like "feature/ENG-142-add-payment-retry"
{{ regexMatch(trigger.output.head_branch, '[A-Z]+-[0-9]+')[0] }}

Step 2 — Transition the issue:

{
  "Resource": "issue",
  "Operation": "transition",
  "IssueKey": "{{ vars.extracted_issue_key }}",
  "TransitionName": "In Review"
}

Step 3 — Add a linking comment:

{
  "Resource": "issue",
  "Operation": "addComment",
  "IssueKey": "{{ vars.extracted_issue_key }}",
  "Comment": "Pull request opened: [{{ trigger.output.pr_title }}|{{ trigger.output.html_url }}]\n\nOpened by {{ trigger.output.user_login }} — ready for code review."
}

Example 4: Add a Comment with Deployment Details to a Release Issue

Scenario: A CI/CD deployment pipeline completes successfully. Find the Jira release issue for this version and append a deployment audit comment with full deployment metadata.

{
  "Resource": "issue",
  "Operation": "addComment",
  "IssueKey": "{{ vars.release_issue_key }}",
  "Comment": {
    "version": 1,
    "type": "doc",
    "content": [
      {
        "type": "panel",
        "attrs": { "panelType": "success" },
        "content": [
          {
            "type": "paragraph",
            "content": [{ "type": "text", "text": "Deployment to {{ vars.environment }} completed successfully.", "marks": [{ "type": "strong" }] }]
          }
        ]
      },
      {
        "type": "table",
        "attrs": { "isNumberColumnEnabled": false },
        "content": [
          {
            "type": "tableRow",
            "content": [
              { "type": "tableHeader", "content": [{ "type": "paragraph", "content": [{ "type": "text", "text": "Property" }] }] },
              { "type": "tableHeader", "content": [{ "type": "paragraph", "content": [{ "type": "text", "text": "Value" }] }] }
            ]
          },
          {
            "type": "tableRow",
            "content": [
              { "type": "tableCell", "content": [{ "type": "paragraph", "content": [{ "type": "text", "text": "Version" }] }] },
              { "type": "tableCell", "content": [{ "type": "paragraph", "content": [{ "type": "text", "text": "{{ vars.version }}" }] }] }
            ]
          },
          {
            "type": "tableRow",
            "content": [
              { "type": "tableCell", "content": [{ "type": "paragraph", "content": [{ "type": "text", "text": "Environment" }] }] },
              { "type": "tableCell", "content": [{ "type": "paragraph", "content": [{ "type": "text", "text": "{{ vars.environment }}" }] }] }
            ]
          },
          {
            "type": "tableRow",
            "content": [
              { "type": "tableCell", "content": [{ "type": "paragraph", "content": [{ "type": "text", "text": "Deployed At" }] }] },
              { "type": "tableCell", "content": [{ "type": "paragraph", "content": [{ "type": "text", "text": "{{ vars.deployed_at }}" }] }] }
            ]
          },
          {
            "type": "tableRow",
            "content": [
              { "type": "tableCell", "content": [{ "type": "paragraph", "content": [{ "type": "text", "text": "Deployed By" }] }] },
              { "type": "tableCell", "content": [{ "type": "paragraph", "content": [{ "type": "text", "text": "{{ vars.deployed_by }}" }] }] }
            ]
          }
        ]
      }
    ]
  }
}

Example 5: Create Sprint and Move Stories to It from Backlog

Scenario: A sprint planning workflow is triggered manually or on a schedule. Create the next sprint, query the highest-priority backlog stories up to the sprint capacity, and move them to the new sprint.

Step 1 — Create the sprint:

{
  "Resource": "sprint",
  "Operation": "create",
  "BoardId": "{{ env.JIRA_BOARD_ID }}",
  "Name": "Sprint {{ vars.sprint_number }}",
  "StartDate": "{{ vars.sprint_start_date }}",
  "EndDate": "{{ vars.sprint_end_date }}",
  "Goal": "{{ vars.sprint_goal }}"
}

Step 2 — Query the top backlog stories by priority:

{
  "Resource": "issue",
  "Operation": "getMany",
  "Jql": "project = {{ env.JIRA_ENG_PROJECT_KEY }} AND issuetype = Story AND status = 'To Do' AND sprint is EMPTY AND priority in (Highest, High) ORDER BY priority DESC, rank ASC",
  "MaxResults": "{{ vars.sprint_capacity_stories }}",
  "Fields": "summary,priority,status,storyPoints"
}

Step 3 — Add the stories to the new sprint:

{
  "Resource": "sprint",
  "Operation": "addIssues",
  "SprintId": "{{ nodes.createSprint.output.id }}",
  "IssueKeys": "{{ map(nodes.getBacklogStories.output.issues, issue => issue.key) }}"
}