Use cases
These are the real tasks Integration Helper for Jira was built around — not abstract questions, but things a Jira/JSM administrator or integration developer actually sits down to do.
Prepare a payload to create or edit an issue
Find the real REST field keys, required fields, data types, allowed operations and allowed values for a specific project × issue type combination — or for one specific issue.
- Project level → Issue Contracts → Create/Edit, for the general contract of a project × issue type.
- Issue level → Edit Contract, opened on a specific issue, for that issue's actual current contract.
Find the canonical ID of a Jira object
The API expects IDs, not the names Jira's UI shows:
customfield_*keys and option IDsaccountIdandgroupId- component, version and security level IDs
- status, resolution, priority and issue type IDs
- project, board, sprint and other project-specific IDs
Global level → Fields (field/option IDs, statuses, resolutions,
priorities, issue types) and Users/Groups (accountId/groupId);
Project level → Components/Versions/Security Levels/Boards
for project-specific IDs.
Diagnose a field or value error in an integration
Check:
- whether the field exists in the right context
- whether that context applies to this project and issue type
- whether the field is available on create or edit
- whether it's required
- which option IDs are valid right now
This helps make sense of errors like invalid option id, field cannot be set and field is required.
The app shows the current configuration — it doesn't determine who changed it or when.
Project level → Issue Contracts, or Global level → Fields → Show contexts, to compare against what the failing request is sending.
Work with workflow transitions through the API
Find:
- the workflow linked to an issue type
- a transition's ID
- its screen's required fields
- the values needed to complete it
Project level → Issue Contracts → Transition shows the configured
transition graph. Which transitions are actually available on one specific issue right now still
depends on its current status and the calling user's permissions — check the live transitions
endpoint for that issue before relying on this for a single in-flight request.
Project level → Issue Contracts → Transition.
Build a Jira Service Management integration
Understand how the JSM and Jira models connect:
- request type → issue type
- the fields of a specific request type
- the ID and values of request fields
- customer request statuses
- SLA, approvals and participants
- queues and their JQL
This helps avoid confusing the Jira Issue API's contract with the JSM Customer Request API's contract.
Project level on a JSM project → Request Types, Queues; Issue level on a request → SLA, Approvals & Participants, Request Status.
Inspect the actual data of an existing issue
Get the real field values and raw JSON for a specific Jira or JSM issue, to:
- check an assumption about the response format
- set up parsing
- see the structure of a complex field
- match a displayed value to its ID
- debug an integration that's already running
Issue level → Fields → Show JSON, per field.
Hand project context to a developer or an LLM
Generate a Project LLM Context file — a snapshot of one project's configuration with its IDs, field contracts, workflow mappings and JSM mappings.
Use it to:
- give an LLM what it needs to write an integration
- attach to an internal team's ticket
- hand to an integrator or consultant
- keep on hand while maintaining an existing automation
This supplements Atlassian's own API documentation — it doesn't replace it. Atlassian documents the general contract; Integration Helper documents this specific site's and project's configuration.
More scenarios
A few narrower cases the same surfaces also cover:
- Looking up component, version and security level IDs before writing a bulk import or migration script.
- Finding a board or sprint ID for a Jira Software automation or report.
- Finding a custom field's key to reference in an Automation rule, a JQL clause, or a dashboard gadget — the app gives you the key and related IDs; building the rule or query itself is still up to you.
- Looking at a project's current roles and their members.
- Checking the current request type → issue type and workflow mappings after a JSM project's configuration changes.
- Looking up Jira Service Management Knowledge Base articles for a bot or self-service integration.