Introduction to ScriptRunner
Discover what ScriptRunner automates in Jira and which feature to use to run scripts, react to events, customize fields, or connect other systems.
If you have a business need that you can't solve with native Jira, you can most likely solve it with ScriptRunner for Jira Isolated Cloud.
Using TypeScript, ScriptRunner lets you interact with Jira's APIs and processes to automate time-consuming manual tasks. It also provides powerful field customization, from creating scripted fields that display calculated information to controlling how fields behave based on user actions, field selections, spaces and work types, user roles, and more.
What you can use ScriptRunner for
ScriptRunner is built around a small set of powerful features. Each solves a different kind of problem.
- Run scripts ad-hoc or on a schedule
- Use the Script console to run custom scripts without setting up permanent automations. Use it to run one-off tasks, test code, experiment with Jira's APIs, and perform bulk updates.
- Use Scheduled jobs to run scripts automatically at set times (for reports, cleanups, and regular syncs).
- React to changes in Jira
- Use Event listeners to trigger scripts when work items are created, updated, transitioned, commented on, and more. Use this to auto-create subtasks, send Slack messages, keep fields in sync, and more.
- Use Workflow rules to attach custom logic to specific workflow transitions (for example, enforcing restrictions before a transition or running automation after it).
- Make fields smarter
- Use Scripted fields to show calculated or dynamic values in a field (for example, totals from subtasks or linked work items, specific date values, and more).
- Use Work item pickers to create custom fields that let users select one or more work items returned by a JQL query (for example, linking to a related work item from a curated list, or dynamically surfacing work items based on other field values).
- Use Field behaviours to change how fields behave on screens so you can show or hide fields, make them required, prefill values, or relabel them based on set values, and more.
- Integrate and extend
- Use HTTP endpoints to create custom APIs so external systems and users can push to or pull from Jira using your own logic.
- Use Automation integrations to add scripted actions to Jira automation flows when built-in actions aren't enough.
Which feature should I use?
Event listeners or Workflow rules?
If your automation is tied to a specific workflow transition, use Workflow rules as they're scoped to that transition and easier to manage. If you need to react to any work item change across multiple workflows or spaces, use Event listeners.
Scripted fields, Field behaviours, or Work item pickers?
Scripted fields are read-only and display calculated values. Field behaviours let you change how fields work on screens (show/hide, set values, make required). Work item pickers let users select one or more work items from a JQL-filtered list.
If you need to show data, use Scripted fields. If you need to control fields, use Field behaviours. If you need users to select certain related work items, use Work item pickers.
Script console or Scheduled jobs?
Use the Script console for one-off tasks you run manually. You can also save scripts for later use. Use Scheduled jobs when you need the same script to run automatically on a schedule.
Do I need to know how to script?
No. Basic knowledge of TypeScript is helpful to get the most out of ScriptRunner, but it's not required.
We provide plenty of example scripts in the app. Select Example scripts in the script editor to see an example beside your own script, then copy it or replace your script with it, and adjust it for your setup.
Get started
Most ScriptRunner features use TypeScript to define custom logic. Whether you're automating workflows, creating dynamic fields, or building custom integrations, you'll write scripts that interact directly with Jira's APIs to accomplish your goals.
If you've migrated from Jira Data Center and are not sure about the differences between scripting in Groovy and TypeScript, see our Scripting in TypeScript guide.
Ready to start? Choose a feature above and see what you can do.