POST /tasks/{task_gid}/stories

Required scope: stories:write

Adds a story to a task. This endpoint currently only allows for comment stories to be created. The comment will be authored by the currently authenticated user, and timestamped when the server receives the request.

Returns the full record for the new story added to the task.

Servers

https://app.asana.com/api/1.0

Path parameters

Name	Type	Required	Description
`task_gid`	String	Yes	The task to operate on.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Query parameters

Name	Type	Required	Description
`opt_pretty`	Boolean	No	Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
`opt_fields[]`	Array	No	This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

Request body fields

Name	Type	Required	Description
`data`	Object	No	A story represents an activity associated with an object in the Asana system.
`data.is_pinned`	Boolean	No	Conditional. Whether the story should be pinned on the resource.
`data.resource_type`	String	No	The base type of this resource.
`data.text`	String	No	The plain text of the comment to add. Cannot be used with html_text.
`data.gid`	String	No	Globally unique identifier of the resource, as a string.
`data.resource_subtype`	String	No	The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning.
`data.created_at`	String	No	The time at which this resource was created.
`data.sticker_name`	String	No	The name of the sticker in this story. `null` if there is no sticker. Valid values: `"yeti_riding_unicorn"` `"phoenix_spreading_love"` `"trophy"` `"celebrating_people"` `"heart"` `"people_waving_flags"` `"splashing_narwhal"` `"dancing_unicorn"` `"green_checkmark"` `"party_popper"` `"people_dancing"` `"determined_climbers"`
`data.html_text`	String	No	Opt In. HTML formatted text for a comment. This will not include the name of the creator.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.