Forums

Articles
Create
cancel
Showing results for 
Search instead for 
Did you mean: 

Create a actual task item in ticket description via API

Leoš MAREK May 29, 2025

Hi,

Im looking for a way how can I add an Actual Task (checkbox item) in the ticket description via API (using Ansible module)

I know for URL the syntax is [title|url] and this results in having a clickable link in the description.

Any ideas?

Thanks

4 answers

1 accepted

1 vote
Answer accepted
Leoš MAREK May 31, 2025

Cant be done via API

4 votes
Viktoriia Golovtseva _TitanApps_
Atlassian Partner
May 30, 2025

Hi @Leoš MAREK You can absolutely inject those little GUI-style checkboxes via the REST API by editing the issue’s description field in Jira’s Atlassian Document Format (ADF). Please check this documentation for details. I think that field input format as checkbox custom field should help.

When you might want more than DIY checklists

If you ever need to:

  • Enforce mandatory items before transitions

  • Reuse the same list via global templates

  • Report on checklist progress in sprints or dashboards

  • Automate checklist insertion based on issue type or workflow

As a representative of the company I can suggest you to check Forge-powered Smart Checklist for Jira app that might help (runs entirely on Atlassian’s infrastructure). With it you can:

  • Build, save and share rich checklist templates across projects

  • Automatically inject a “Definition of Done” or Onboarding list on issue creation

  • Prevent tickets from moving forward until all required items are ticked

  • Tag teammates, add per-item notes or links, and track completion on your board

 

1 vote
Natalya Ozhigova
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
May 30, 2025

Hi Leoš MAREK 

Could you try "[] " these symbols? Like "[] some text"

Best regards

Natalya

Aaron Williams
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
May 31, 2025

I've tried trigger this via API and unfortunately it just copies everything as plain text. 

I think I needs to be triggered in a certain way which the API doesn't allow. 

Leoš MAREK May 31, 2025

I have the same result. Guess the only formatting available via API is the rich text things and tables mentioned in the docu (similar to markdown language).

thanks for trying

Like Natalya Ozhigova likes this
1 vote
Aaron Williams
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
May 29, 2025

Hey @Leoš MAREK 

Do you mean you wish to take the result of a check box and add it to a ticket description as a line of text?

Say you have checkbox 1, checkbox 2 and checkbox 3

And checkbox 2 was selected. Via API you'd like a ticket that has "checkbox 2" in the description. 

Is that correct? 

Thanks

Aaron. 

Leoš MAREK May 29, 2025

Hi,

no not really.

I would like to make one ticket and in that ticket Description, instead of for example having a list

- item 1

- item 2

I would like to have

checkbox 1

checkbox 2

So that the person who grabs the ticket, can check those boxes when done with the step. A sort of a checklist, but dont really want to create sub-tasks for it, as those are 3 simple steps only.

Thx

Aaron Williams
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
May 29, 2025

Ah ok. 

You won't be able to add checkboxes into the ticket description, it only accepts rich text. The native Jira solution is subtasks, although you've mentioned you'd prefer not to use them. 

To achieve what you need you would need to look at the checklist market place app, but there is a cost associated with this. 

Thanks

Aaron. 

Leoš MAREK May 29, 2025

Not sure if we fully understand each other.

It is possible to add checkbox in the ticket description via GUI 

Screenshot 2025-05-30 075703.png

Im asking whether this is possible via API.

Suggest an answer

Log in or Sign up to answer
DEPLOYMENT TYPE
CLOUD
PRODUCT PLAN
FREE
TAGS
AUG Leaders

Atlassian Community Events