I tried passing formatted text as the description to the https://api.awork.com/api/v1/tasks endpoint. The styling that I tried to apply was taken from here. Unfortunately this did not work for me. Am I doing something wrong or is it simply not possible to get a styled description when using the api?
Thanks already in advance for any help or guidance.
Hey @Alex6 and thanks for reaching out. We will take a look at this. Do you have a trace id? Then we can look at exactly what you are passing for the description
This should be one of the traceIds where I tested this: a4c1e6a64229983c7e7e92a0be794b20
I am simply passing “# Headline“ as the description but this is only rendered as plaintext in the task description and no styling is applied.
Hey @Alex6 thanks for getting back with the trace id! You’re right: Passing “# Headline” is only rendered as plain text, and this is because the “#” is only a shortcut for creating the heading within the editor. The editor uses a rich text editor- style format. Passing “# Heading” is wrapped into a paragraph and treated as plain text.
The actual persisted content for an h1 heading is the following:
Putting it here as an image, because it would get rendered as a heading here as well.
So if you pass that it will get rendered as a heading in the editor.
So essentially the editor expects HTML instead of markdown.
We will adjust the developer docs accordingly.
Makes sense. Thanks for answering so quickly.