Hooks / Docs / Get started

Get started

Last updated 24/08/2026

Hooks is a Jira Cloud app for writing automation in TypeScript/JavaScript instead of a proprietary scripting language. Scripts run ad-hoc from a console, automatically on ten kinds of work-item events, on a schedule, behind a JQL search function, as a computed field, or across thousands of work items as a bulk job — and every run records its logs, timing, result, and line-numbered errors, replayable at any time.

Install and first run

1. Install from the Atlassian Marketplace (Get it now) and choose your Jira Cloud site. The app installs through Atlassian Forge — no separate download, no external service.
2. Approve the permissions: read and write work items, read user profiles, and app storage for your scripts. No external network access is requested.
3. Open Hooks under Jira Settings (⚙) → Apps → Hooks. Only users with the Administer Jira permission can open the app or call its APIs.
4. Run the sample. The Console comes pre-filled — click Run and expect a green OK with your display name and recent work items.

Finding your way

The sidebar mirrors the feature set: Overview (live counts and shortcuts), Console (write & run), Listeners, Scheduled hooks, JQL functions, Scripted field, Bulk jobs, All hooks, and Run history. Each feature tab lists its own hooks and its “New …” button opens the Console with the right trigger preselected.