Notifications

Notifications represent activity delivered to a user's Inbox.

MarkNotifications

PropertyTypeDescription
failed_gids[][string]The GIDs from notification_gids that could not be updated, for example because the notification does not exist, does not belong to the caller, or has been deleted. GIDs not listed here were updated successfully. Empty when every GID succeeded.

Example JSON for MarkNotifications:

{
  "failed_gids": [
    "1234567891"
  ]
}

Notification

PropertyTypeDescription
gidstringGlobally unique identifier of the resource, as a string.
resource_typestringThe base type of this resource.
priority_classificationstringThe notification's Priority classification.
Click to show all enum values
  • unclassified
story_resource_subtypestringThe stable public subtype of the Story that produced the notification.
work_objects[][object]Work referenced by the notification. Each entry is a compact representation of the underlying Asana resource.
work_objects[].gidstringGlobally unique identifier of the resource, as a string.
work_objects[].resource_typestringThe base type of this resource.
work_objects[].namestringThe name of the object.
storyobjectThe Story that produced the notification. This is null when the activity is not exposed through the Stories API.
story.gidstringGlobally unique identifier of the resource, as a string.
story.resource_typestringThe base type of this resource.
story.comment_gidstringConditional. The GID of this comment's envelope, distinct from the story gid. Request with opt_fields=comment_gid on story reads. For a top-level task comment, pass this value as parent_comment when creating a threaded reply. Null for a legacy comment without an envelope; absent on non-comment stories.
story.anchor_gidstringConditional. The GID of the object this comment is anchored to. For a top-level task comment this is the task GID; for a threaded reply this is the parent comment's envelope GID (comment_gid). Also present on sticker stories. Request with opt_fields=anchor_gid on story reads.
story.created_atstring (date-time)The time at which this resource was created.
story.created_byobjectA user object represents an account in Asana that can be given access to various workspaces, projects, and tasks.
story.created_by.gidstringGlobally unique identifier of the resource, as a string.
story.created_by.resource_typestringThe base type of this resource.
story.created_by.namestringRead-only except when same user as requester. The user's name.
story.resource_subtypestringThe 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.
story.textstringCreate-only. Human-readable text for the story or comment. This will not include the name of the creator. Note: This is not guaranteed to be stable for a given type of story. For example, text for a reassignment may not always say “assigned to …” as the text for a story can both be edited and change based on the language settings of the user making the request. Use the resource_subtype property to discover the action that created the story.
created_byobjectThe computed actor responsible for the underlying activity, or null when no actor is available.
created_by.gidstringGlobally unique identifier of the resource, as a string.
created_by.resource_typestringThe base type of this resource.
created_by.namestringThe name of the object.
created_atstring (date-time)The time at which the notification was created.
is_readbooleanWhether the notification is effectively read in the user's Inbox.

Example JSON for Notification:

{
  "gid": "12345",
  "resource_type": "notification",
  "priority_classification": "unclassified",
  "story_resource_subtype": "comment_added",
  "work_objects": [
    {
      "gid": "12345",
      "resource_type": "task",
      "name": "Bug Task"
    }
  ],
  "story": {
    "gid": "12345",
    "resource_type": "story",
    "comment_gid": "12345",
    "anchor_gid": "12345",
    "created_at": "2012-02-22T02:06:58.147Z",
    "created_by": {
      "gid": "12345",
      "resource_type": "user",
      "name": "Greg Sanchez"
    },
    "resource_subtype": "comment_added",
    "text": "marked today"
  },
  "created_by": {
    "gid": "12345",
    "resource_type": "task",
    "name": "Bug Task"
  },
  "created_at": "2026-08-20T18:42:31.123Z",
  "is_read": false
}