User Guide
Synapse-Jira User Guide
Synapse-Jira adds new Storm commands to allow you to query the Jira API using your existing API key.
Getting Started
Check with your Admin to enable permissions and find out if you need a personal API key, domain, and/or username.
Examples
Setting your personal Jira Cloud API key
To set-up a personal use Jira Cloud API key:
> jira.config.add my_cloud_config cloud myapikey jira_hostname --username myusername --scope self
Synapse-Jira config "my_cloud_config" added
Setting your personal Jira Server API key
To set-up a personal use Jira Server API key:
> jira.config.add my_server_config server myapikey jira_hostname --scope self
Synapse-Jira config "my_server_config" added
Display the list of Jira users
> jira.users --project TEST
Display Name | Email Address
==========================================|==========================================
blackout | michael.squires@vertex.link
------------------------------------------|------------------------------------------
visi | visi@vertex.link
------------------------------------------|------------------------------------------
whippit | whippit@vertex.link
Search for issues in project “TEST” and create nodes from the results
> jira.issue.search 'project = "TEST"' --yield
proj:ticket=3df3989724dbd3b7e5d9079eb17f1064
.created = 2026/02/06 16:27:40.021
:assignee = a88175a04deab2920e2d3927ecf8044b
:created = 2026/01/29 15:20:17.000
:creator = a88175a04deab2920e2d3927ecf8044b
:ext:url = https://framework.local/rest/api/2/issue/10104
:id = TEST-5
:name = AS: synapse-jira W: create tickets from synapse
:priority = medium
:project = 8e68f4b6e87f3e10b967b5dff1853be0
:status = done
:type = task
:updated = 2026/01/29 15:43:56.000
proj:ticket=8d5c35adde5c0a0e00b4cd4f34a39f58
.created = 2026/02/06 16:27:40.034
:created = 2026/01/29 15:14:02.000
:creator = a88175a04deab2920e2d3927ecf8044b
:ext:url = https://framework.local/rest/api/2/issue/10103
:id = TEST-4
:name = AS: synapse-jira W: ticket with no labels
:priority = medium
:project = 8e68f4b6e87f3e10b967b5dff1853be0
:status = new
:type = task
:updated = 2026/01/29 15:14:02.000
proj:ticket=51d699bc5aaa4a3244029734274a7a1d
.created = 2026/02/06 16:27:40.043
:assignee = a88175a04deab2920e2d3927ecf8044b
:created = 2026/01/29 12:58:06.000
:creator = a88175a04deab2920e2d3927ecf8044b
:desc = Add the bar functionality.
:ext:url = https://framework.local/rest/api/2/issue/10102
:id = TEST-3
:name = AS: synapse-jira W: ticket with SUB-TASK type
:priority = high
:project = 8e68f4b6e87f3e10b967b5dff1853be0
:status = new
:type = sub-task
:updated = 2026/01/29 13:57:05.000
#rep.jira.test_jira_search
proj:ticket=9e890b0bda6d8f40dbb342260cec0f73
.created = 2026/02/06 16:27:40.055
:created = 2026/01/29 12:57:29.000
:creator = a88175a04deab2920e2d3927ecf8044b
:desc = The foo needs to bar.
:ext:url = https://framework.local/rest/api/2/issue/10101
:id = TEST-2
:name = AS: synapse-jira W: ticket with TASK type
:priority = highest
:project = 8e68f4b6e87f3e10b967b5dff1853be0
:status = new
:type = task
:updated = 2026/01/29 14:25:46.000
#rep.jira.test_jira_search
proj:ticket=8e68f4b6e87f3e10b967b5dff1853be0
.created = 2026/02/06 16:27:40.077
:assignee = a88175a04deab2920e2d3927ecf8044b
:created = 2026/01/28 21:02:25.000
:creator = a88175a04deab2920e2d3927ecf8044b
:ext:url = https://framework.local/rest/api/2/issue/10100
:id = TEST-1
:name = AS: synapse-jira W: create tickets from synapse
:priority = medium
:project = 8e68f4b6e87f3e10b967b5dff1853be0
:status = in progress
:type = task
:updated = 2026/01/29 15:40:18.000
#rep.jira.reviewed
Search for issues in project “TEST” with priority “Highest” and display the results
> jira.issue.search 'project = "TEST" and priority="Highest"' --dry-run
id: TEST-2
url: https://framework.local/rest/api/2/issue/10101
name: AS: synapse-jira W: ticket with TASK type
desc: The foo needs to bar.
type: Task
status: new
priority: Highest
reporter: JIRAUSER10000
created: 2026-01-29T12:57:29.000+0000
updated: 2026-01-29T14:25:46.000+0000
labels: test_jira_search
comment by: JIRAUSER10000
Eligendi pariatur adipisci omnis deleniti optio.
Create an issue of type “Task” in the project “TEST”
> jira.issue.create TEST Task "As: User Want: Vroom Vroom So: Analysis"
Made TEST-6
Use of meta:source nodes
Synapse-Jira uses a meta:source node and -(seen)> light
weight edges to track nodes observed from the Jira API.
> meta:source=234bc70639056c7f8400c2429fcb70ea
meta:source=234bc70639056c7f8400c2429fcb70ea
.created = 2026/02/06 16:27:40.018
:name = jira api
:type = synapse.jira
Storm can be used to filter nodes to include/exclude nodes which have been observed by Synapse-Jira. The following example shows how to filter the results of a query to include only results observed by Synapse-Jira:
> proj:project +{ <(seen)- meta:source=234bc70639056c7f8400c2429fcb70ea }
proj:project=8e68f4b6e87f3e10b967b5dff1853be0
.created = 2026/02/06 16:27:40.025
:name = test project