Important update: Koppla will no longer operate after April 15, 2024.

After this date, Atlassian will delete your stored Koppla data from their Forge storage platform. You may uninstall and delete the application from your instance at any time before this date. We have loved developing and working on Koppla and supporting users in bringing their external data into their Jira issues. After three years of journey, we decided to sunset Koppla and focus on improving our growing products. Thank you for choosing Koppla and being a loyal customer. If you have any questions or concerns, we are always here to help. Please feel free to reach out to us.

This page is a guide for your developer!

Once the project is configured you will need someone to create a script that gathers and submits data to Koppla using any language or automation utility. This doc explains the submission process.

Jump to:

1 Important update: Koppla will no longer operate after April 15, 2024.
- 1.1 Information you’ll need to send the data
- 1.2 How to send the data
  - 1.2.1 Example Script
  - 1.2.2 Rendered Output
- 1.3 How to remove data
- 1.4 Data limitation information

Information you’ll need to send the data

You will need 3 pieces of configuration from the Jira Project Administrator

Configuration	Details	Example

Configuration	Details	Example
Trigger Url (#1)	This is project-specific. The project administrator can provide this to you from the Koppla admin screen.	https://26966d8dsdfsdf-4ettb7-4qfef09febf0551.hello.atlassian-dev.net/x1/Helsei-aGeW4cbXa9QZo4?project=71332
Event Source Key (#2)	A project can have multiple event sources.	bh-buaaayfasd2a4qbht_mcsdrho
API Token (#3	There is a single API Token per project. This api token should be treated as any other credential as anyone with it can submit data to an event source.	hwdhfjshdfjhsd3SDFFasdd

Koppla - Project Configuration Screen - Accessible by Project Admins Only

How to send the data

Each connection data needs to provide 5 items:

Item	Description	Status

Item	Description	Status
Title	This is the title of the remote data and will appear bolded in the Jira issue	Required
Description	The description of the remote data piece.	Required
Time	A text string of date (example 2020/12/31). If none is provided - the current date is assumed.	Optional
Lookup Value	The value that this refers to in the field that the project administrator configured.	Required
URL		Required

Once you have the information above, you can trigger a HTTP POST to the trigger url.

The authorization header should contain the API Token and the body of the request should be a JSON formatted string including the title, description, time and url.

At the end of the trigger url append &key=[event source key]&value=[the lookup value] (replace [the lookup value] with the value and [event source key] with the even source key).

Example Script

curl -X POST \
-H "authorization:hwdhfjshdfjhsd3SDFFasdd" \
-d '{
        "time":"2019/02/03", 
        "title":"This happened a while back", 
        "description":"This is the description of the request"
}' \
'https://26966d8dsdfsdf-4ettb7-4qfef09febf0551.hello.atlassian-dev.net/x1/Helsei-aGeW4cbXa9QZo4?project=71332&key=bh-buaaayfasd2a4qbht_mcsdrho&value=BBB'

This will trigger ingest an item from Feb 3, 2019 with a title of “This happened a while back” and will be shown on an issue in the project where the field has a value of BBB.

Rendered Output

How to remove data

Any data sent in has to be removed by the project administrator through the user interface.

Data limitation information

Each lookup value can have multiple values sent in however the total size of all of the data stored for a single look up value is limited to 32k. Once you exceed this, the earliest values are removed in order to make room for the new entry.

Atlassian Forge does impose limits on the total data stored. For more details - please see https://developer.atlassian.com/platform/forge/platform-quotas-and-limits/#storage-quotas

Submit Event Source Data