Shorter Loop API Documentation
  1. Getting started
Shorter Loop API Documentation
  • Getting started
    • Welcome to the Shorter Loop API Portal
    • Authentication
    • Base URL
    • 2 way Jira Integration
    • Create webhook in Shorter Loop
  • Metrics
    • Create a Key Performance Indicator (KPI)
      POST
    • Update the Key Performance Indicator (KPI)
      PUT
    • Retrieve KPIs not linked to specific product backlog items
      GET
    • Insert KPI's records (Body JSON Payload)
      POST
    • Insert KPI's records (Upload CSV)
      POST
    • Insert KPI's records (Upload JSON)
      POST
  • Idea manager
    • Feedback Collection
      • Create idea and issue
      • Retrieves a list of categories
      • Modify feedback item
      • Removes a feedback item
      • Upvote or downvote a work item
      • Retrieve a feedback item
      • Get comments for a feedback item.
      • Reply to a comment
      • Modify a comment
      • Bulk create feedback items: CSV and JSON
    • Segments
      • Retrieves a list of segments without users
      • Create segment
      • Modify a segment
      • Removes a segment
      • Bulk create users to a segment
      • Manage user segments: move or remove
      • Retrieve segments with users
      • Retrieve segment with users
      • Import Users (CSV/JSON)
      • Sending email to segment members
      • Sending email to selected idm members
    • Bulk create idea manager members
      POST
    • Import Users (CSV/JSON) in IDM
      POST
    • Bulk re-invite in IDM
      PUT
  • Backlog Management
    • Epics
      • Create a new epic
      • Modify an epic
      • Retrieve details of the epic
      • Removes the epic
    • Features
      • Create a new feature
      • Modify a feature
      • Retrieve details of the feature
      • Removes the feature
    • User stories
      • Create a new user story
      • Modify a user story
      • Retrieve user story
      • Removes the user story
    • Assets
      • Attaches files to the workitem
      • Removes an asset
      • Retrieve attachments for the backlog workitem with ID
    • Product Tags
      • Retrieves tags for initiative
    • Teams
      • Get teams and members for product
    • Personas
      • Retrieve personas associated with initiative
    • Get whole backlog tree
      GET
  • Strategy Board
    • Experiment
      • Create a new experiemnt variant
    • Solutions
      • Versions
        • Storymap versions api documentation
        • Create a version
        • Update version
        • Removes a version
        • Retrieve versions
      • Get all storymaps for solution
  • Persona Board V2
    • Segments
      • Permanently deletes a segment
      • Creates a new option
      • Retrieve a list of segments
      • Retrieve a segment
      • Create a segment
      • Removes a segment
      • Removes a segment option
      • Detaches a segment from the persona
      • Update segment option
    • Custom fields
      • Removes a custom field
      • Retrieve a list of custom fields
      • Retrieve a custom field
      • Create a custom field
      • Removes a custom field option
      • Detaches a custom field from persona
      • Retrieve custom fields excluding persona
      • Creates a new option
      • Permanently deletes a custom field
      • Update custom field
      • Update custom field option
      • Attach a custom field to a persona
    • Create opportunities from summary
    • Retrieve notes
    • Retrieve persona
    • Retrieve experiments for Persona
    • Create
    • Retrieve
  • DocsHub
    • Retrieve categories with templates
    • Retrieve a template based on category
    • Create copy of template while using template
  • testing
    GET
  1. Getting started

2 way Jira Integration

Jira 2 way integrations

Sync seamlessly both ways—push work items to Jira or import Jira tickets into Shorter Loop.

Keep your Jira projects up to date by enabling Jira Sync while you're exploring or switching to Shorter Loop.

Use CSV or APIs to perform a one-time import from Jira into Shorter Loop. Refer.: https://developer.shorterloop.com

Jira-SL.png

Overview: Flexible Transition Paths to Shorter Loop

Teams adopt Shorter Loop in ways that best fit their workflows. Some opt for an immediate switch, importing all existing issues at once. Others prefer a gradual adoption, starting with a small team to evaluate the platform's fit.

To support a phased transition, Shorter Loop offers 2-Way Jira Sync. This feature enables seamless integration between Jira projects and Shorter Loop teams, ensuring that new issues created in either system are automatically synchronized. This bidirectional sync maintains consistency across platforms, allowing teams to collaborate effectively during the transition period.

Navigate to Integrations → Apps Section and click on Link from Jira.

Prerequisites & Permissions

  • ADMINISTER permission
    The Jira account you use to create the API token must have the GLOBAL ADMINISTER permission in Jira. This is required so Shorter Loop can register webhooks.

    • Once setup is complete, you can revoke that permission in Jira without breaking the integration.

    • If you don’t want to assign a Shorter Loop seat to this admin user or store that permission in Shorter Loop, see our FAQ for alternatives.

  • API Token lifespan
    Atlassian tokens default to 7 days. When you generate yours, set its expiration to 1 year to avoid frequent renewals.

How to Setup?

  1. Open the Link dialog

    • In Shorter Loop, go to Integrations → Apps, then click Link from Jira.

Link-jira-account.png

  1. Generate or locate your API token

    • In Jira: Settings → Security → API tokens → Create token (or copy an existing one).

    • On creation, choose an expiration of 12 months.

  2. Collect your credentials

    • API Token

    • Email for your Jira user

    • Jira Hostname (e.g. yourcompany.atlassian.net)

  3. Authenticate

    • In the Shorter Loop dialog, paste API Token, Email, and Hostname, then click Link.
  4. Confirmation

    • Success: You’ll see a green “Linked successfully” banner.

    • Error: A red message will explain what went wrong (invalid token, mistyped hostname, etc).

  5. Import of Projects

    • Immediately after linking, Shorter Loop imports every Jira project in your instance.

Reminder: Imported projects are not yet connected with Shorter Loop—no sync is active until you connect them to a team.

imported-jira-projects.png

Step 2 — Connect Projects to Teams

Each Jira project must be paired with exactly one Shorter Loop team. Follow these steps:

  1. Ensure you have at least one team

    • If none exist, you’ll see: “You need to create at least one team to integrate with Jira.”

    • Head to Teams → Create Team, then return here.

  2. Start the connection flow

    • Under Integrations → Apps, locate your imported Jira projects.

    • Click Connect on the project you want to sync.

Connect-project.png

Step 1: Choose a Team

  • A three-step wizard appears.

  • Team dropdown lists only teams not already linked to another project.

  • If your current header-dropdown team is unlinked, it will be pre-selected.

  • Click Continue (or Back to cancel).

Select-team.png

Step 2: Select Work-Item Types

  • Pick which types of issues you want in sync (e.g. bugs, tasks, epics).

  • Click Continue.

Workitem mapping.png

Step 3: Map Fields

  • Align Jira fields (summary, description, status, etc.) with Shorter Loop fields.

  • Click Continue to finalize.

jira-workitem-mapping.png

Automatic Sync Activation

  • The moment you finish Step 3, Shorter Loop creates a Jira webhook and begins bi-directional sync:

    • Push: New or updated work items in Shorter Loop go to the respective Jira Project.

    • Pull: New or updated issues in Jira appear in Shorter Loop's team backlog.

Note: Only those Shorter Loop workitems are pushed to jira which has a Team assigned.

connected.pngwebhook.png

Additionally, a webhook is also created in Shorter Loop.

webhook-sl.png

shorterloopId & Cleanup on Disconnection

Duplication prevention

A custom field named shorterloopId (this is our Smart key) is created automatically by Shorter Loop in Jira.

Update vs. create

If an incoming issues carries a shorterloopId, we will update the existing work item; if not, it will create a new one.

Automatic field creation

During the “Link from Jira” step, Shorter Loop automatically provisions the shorterloopId custom field in your Jira instance.

IMPORTANT: Team-managed projects

For team-managed Jira projects, you must manually add the shorterloopId field to each work type in Jira:

  1. Go to Jira Project Settings → Fields → Add Field

  2. Search for shorterloopId, select it, and click Add

add-field.png

  1. Switch to Work Types in Project Settings

  2. Under each work type’s Text Fields, click shorterloopId to include it (You need to do it for all the work types you have in Jira)

adding-to-epic.png

  1. Save changes

Note: If this manual addition is not performed, there are chances of duplicate items in jira and Shorter Loop on each re-connection.

Disconnect cleanup

  • When a user disconnects a Jira project, Shorter Loop removes all Jira metadata from the associated work items.

  • If a user fully unlinks from Jira, Shorter Loop deletes the Jira project connection and wipes out all Jira details from every synced work item.

  • Removing the jira connected Shorter Loop Team will automatically disconnected the jira project.

Previous
Base URL
Next
Create webhook in Shorter Loop
Built with