How to Run TypeScript in Jira Cloud

Can you run TypeScript in Jira Cloud?

• Jira does not provide a general-purpose built-in TypeScript editor for arbitrary admin scripts.
• Jira Automation handles many no-code and low-code scenarios.
• Advanced code-driven logic usually requires an app or a custom Forge application.
• Script Studio provides a ready-made TypeScript scripting environment for Jira Cloud.

Benefits

Why use TypeScript for Jira Cloud automation?

TypeScript in Jira Cloud gives technical teams the same language and tooling they already use elsewhere, applied to Jira scripting.

When Jira Automation is enough — and when TypeScript helps

Use Jira Automation when it is sufficient. Use scripting when your requirements become more complex.

Ways to run TypeScript in Jira Cloud

There are three practical approaches to Jira Cloud scripting with TypeScript.

How TypeScript scripting works in Script Studio

1. 01

   Open the Workbench

   Open Script Studio from Jira administration and create or edit TypeScript files.

2. 02

   Write your Jira logic

   Use TypeScript and Jira REST APIs to implement the required behavior.

3. 03

   Choose how the script runs

   Connect the script to an event listener, scheduled job, workflow function, calculated field, HTTP endpoint or issue form.

4. 04

   Run and monitor

   Execute scripts and review run history and execution results from the same environment.

Practical Jira TypeScript use cases

Short examples based on the Script Studio scripting documentation. Each script is a TypeScript file with a default exported function.

import { jira } from 'jira-api';

export default async function run(_getIssue: GetIssue, context: ScriptContext) {
  // context.event is populated when an event listener starts the script
  const { key, subject } = context.event;
  console.log(`Event ${key} on ${subject}`);
  // Apply custom logic here
}

export default async function run(_getIssue: GetIssue, context: ScriptContext) {
  // context.trigger is 'schedule' when the cron schedule starts the script
  console.log('Running scheduled Jira maintenance task', context.trigger);
}

import { jira } from 'jira-api';

export default async function run() {
  const issue = await jira.get('/rest/api/3/issue/{issueIdOrKey}', {
    path: { issueIdOrKey: 'PROJ-1' },
    query: { fields: ['summary', 'status', 'assignee'] },
  });
  return issue.key;
}

One script, many triggers: the execution context

Every Script Studio script receives a context object as its second parameter. Its trigger property says how the script was started, so a single TypeScript file can support several execution points.

Good to know before you start

• Shared code works like any TypeScript project: scripts import each other by relative path, for example a lib/jira-helpers.ts file reused by several schedules and listeners.
• Only files inside the workspace can be referenced; external npm packages cannot be installed.
• Scripts run on the Atlassian platform, not in the browser. Diagnosis is done through the output panel and the run history rather than breakpoints.
• The Jira client covers the Jira platform REST API. Arbitrary outbound network requests are not available, so integrations usually flow in through Script Studio HTTP endpoints.
• Each execution has limits, such as 50 Jira API calls per run and 32 KB per script file, designed to keep scripts safe for the whole Jira site.
• Script Studio ships with an example library of 80 documented scripts across 11 categories, from JQL searches to sprint reports.

What can you automate with TypeScript in Jira Cloud?

Frequently asked questions