Create
cancel
Showing results for 
Search instead for 
Did you mean: 
Sign up Log in
It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

Trying to include a link in description field API v 3

I have an application that creates templated stories based on a template stored in an xml file.  We have documents we want to include in the description for reference and when I try to include the link (Google Docs) the result is not clickable.  I tried a few things such as the [title|http://link,com]  which does not work and If I use html markup that shows the mark up.

Thanks

1 answer

1 vote
DPK J Community Leader Aug 22, 2019

Jira cloud API accepts ADF (Atlassian Document Format) for `Description Field`.

So you need to send something like this in API as payload against `Description` field.

{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Google","marks":[{"type":"link","attrs":{"href":"http://google.com"}}]}]}]}

 

You can learn about ADF in this session/talk

https://www.atlassian.com/atlascamp/watch-sessions/the-atlassian-platform-for-developers/the-atlassian-document-format-is-coming-to-an-api-near-you

thanks for this...worked like a charm

Suggest an answer

Log in or Sign up to answer
TAGS
Community showcase
Published in Apps & Integrations

Send an Email or Publish to Confluence - What should you do with your release notes?

Background When you hear the words ‘Release notes’, almost always you think of an unsolicited email from a software vendor. But I am here to tell you that from our data, sending release notes via E...

42 views 0 1
Read article

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you