> ## Documentation Index > Fetch the complete documentation index at: https://www.canva.dev/docs/apps/llms.txt > Use this file to discover all available pages before exploring further. # Comment notifications The NotificationContent sent when a user comments on a design. This webhook isn't triggered for a user's own comments, as users don't receive notifications for their own comments in Canva. If the `type` of [notification](https://www.canva.dev/docs/apps/rest-apis/webhooks/#notification) is `comment`, the webhook payload object contains the following parameters: The unique identifier for the notification. When the notification was created, as a UNIX timestamp (in seconds since the UNIX epoch). The notification content for when someone comments on a design. Properties of content} defaultExpanded={true}> **Available values:** The only valid value is `comment`. Metadata for the user, consisting of the User ID and display name. Properties of triggering_user}> The ID of the user. The name of the user as shown in the Canva UI. Metadata for the user, consisting of the User ID, Team ID, and display name. Properties of receiving_team_user}> The ID of the user. The ID of the user's Canva Team. The name of the user as shown in the Canva UI. Basic details about the design, such as the design's ID, title, and URL. Properties of design}> The design ID. A temporary set of URLs for viewing or editing the design. Properties of urls}> A temporary editing URL for the design. This URL is only accessible to the user that made the API request, and is designed to support [return navigation](https://www.canva.dev/docs/apps/rest-apis/return-navigation-guide/) workflows. NOTE: This is not a permanent URL, it is only valid for 30 days. A temporary viewing URL for the design. This URL is only accessible to the user that made the API request, and is designed to support [return navigation](https://www.canva.dev/docs/apps/rest-apis/return-navigation-guide/) workflows. NOTE: This is not a permanent URL, it is only valid for 30 days. When the design was created in Canva, as a Unix timestamp (in seconds since the Unix Epoch). When the design was last updated in Canva, as a Unix timestamp (in seconds since the Unix Epoch). The design title. URL of the design. A thumbnail image representing the object. Properties of thumbnail}> The width of the thumbnail image in pixels. The height of the thumbnail image in pixels. A URL for retrieving the thumbnail image. This URL expires after 15 minutes. This URL includes a query string that's required for retrieving the thumbnail. The total number of pages in the design. Some design types don't have pages (for example, Canva docs). The type of comment event, including additional type-specific properties. Event type for a new comment thread. **Available values:** The only valid value is `new`. A URL to the design, focused on the comment thread. A discussion thread on a design. The `type` of the thread can be found in the `thread_type` object, along with additional type-specific properties. The `author` of the thread might be missing if that user account no longer exists. Properties of comment}> The ID of the thread. You can use this ID to create replies to the thread using the [Create reply API](https://www.canva.dev/docs/apps/rest-apis/reference/comments/create-reply/). The ID of the design that the discussion thread is on. The type of the discussion thread, along with additional type-specific properties. A comment thread. **Available values:** The only valid value is `comment`. The content of a comment thread or reply. Properties of content}> The content in plaintext. Any user mention tags are shown in the format `[user_id:team_id]`. The content in markdown. Any user mention tags are shown in the format `[user_id:team_id]` The Canva users mentioned in the comment thread or reply. Properties of mentions}> Information about the user mentioned in a comment thread or reply. Each user mention is keyed using the user's user ID and team ID separated by a colon (`user_id:team_id`). ```json { "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP": { "tag": "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP", "user": { "user_id": "oUnPjZ2k2yuhftbWF7873o", "team_id": "oBpVhLW22VrqtwKgaayRbP", "display_name": "John Doe" } } } ``` The mention tag for the user mentioned in the comment thread or reply content. This has the format of the user's user ID and team ID separated by a colon (`user_id:team_id`). Metadata for the user, consisting of the User ID, Team ID, and display name. Properties of user}> The ID of the user. The ID of the user's Canva Team. The name of the user as shown in the Canva UI. Metadata for the user, consisting of the User ID and display name. Properties of assignee}> The ID of the user. The name of the user as shown in the Canva UI. Metadata for the user, consisting of the User ID and display name. Properties of resolver}> The ID of the user. The name of the user as shown in the Canva UI. A suggestion thread. **Available values:** The only valid value is `suggestion`. The type of the suggested edit, along with additional type-specific properties. **Minimum items:** `1` A suggestion to add some text. **Available values:** The only valid value is `add`. A suggestion to delete some text. **Available values:** The only valid value is `delete`. A suggestion to format some text. **Available values:** The only valid value is `format`. The suggested format change. **Available values:** * `font_family` * `font_size` * `font_weight` * `font_style` * `color` * `background_color` * `decoration` * `strikethrough` * `link` * `letter_spacing` * `line_height` * `direction` * `text_align` * `list_marker` * `list_level` * `margin_inline_start` * `text_indent` * `font_size_modifier` * `vertical_align` The current status of the suggestion. **Available values:** * `open`: A suggestion was made, but it hasn't been accepted or rejected yet. * `accepted`: A suggestion was accepted and applied to the design. * `rejected`: A suggestion was rejected and not applied to the design. When the thread was created, as a Unix timestamp (in seconds since the Unix Epoch). When the thread was last updated, as a Unix timestamp (in seconds since the Unix Epoch). Metadata for the user, consisting of the User ID and display name. Properties of author}> The ID of the user. The name of the user as shown in the Canva UI. Event type for a comment thread that has been assigned. **Available values:** The only valid value is `assigned`. A URL to the design, focused on the comment thread. A discussion thread on a design. The `type` of the thread can be found in the `thread_type` object, along with additional type-specific properties. The `author` of the thread might be missing if that user account no longer exists. Properties of comment}> The ID of the thread. You can use this ID to create replies to the thread using the [Create reply API](https://www.canva.dev/docs/apps/rest-apis/reference/comments/create-reply/). The ID of the design that the discussion thread is on. The type of the discussion thread, along with additional type-specific properties. A comment thread. **Available values:** The only valid value is `comment`. The content of a comment thread or reply. Properties of content}> The content in plaintext. Any user mention tags are shown in the format `[user_id:team_id]`. The content in markdown. Any user mention tags are shown in the format `[user_id:team_id]` The Canva users mentioned in the comment thread or reply. Properties of mentions}> Information about the user mentioned in a comment thread or reply. Each user mention is keyed using the user's user ID and team ID separated by a colon (`user_id:team_id`). ```json { "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP": { "tag": "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP", "user": { "user_id": "oUnPjZ2k2yuhftbWF7873o", "team_id": "oBpVhLW22VrqtwKgaayRbP", "display_name": "John Doe" } } } ``` The mention tag for the user mentioned in the comment thread or reply content. This has the format of the user's user ID and team ID separated by a colon (`user_id:team_id`). Metadata for the user, consisting of the User ID, Team ID, and display name. Properties of user}> The ID of the user. The ID of the user's Canva Team. The name of the user as shown in the Canva UI. Metadata for the user, consisting of the User ID and display name. Properties of assignee}> The ID of the user. The name of the user as shown in the Canva UI. Metadata for the user, consisting of the User ID and display name. Properties of resolver}> The ID of the user. The name of the user as shown in the Canva UI. A suggestion thread. **Available values:** The only valid value is `suggestion`. The type of the suggested edit, along with additional type-specific properties. **Minimum items:** `1` A suggestion to add some text. **Available values:** The only valid value is `add`. A suggestion to delete some text. **Available values:** The only valid value is `delete`. A suggestion to format some text. **Available values:** The only valid value is `format`. The suggested format change. **Available values:** * `font_family` * `font_size` * `font_weight` * `font_style` * `color` * `background_color` * `decoration` * `strikethrough` * `link` * `letter_spacing` * `line_height` * `direction` * `text_align` * `list_marker` * `list_level` * `margin_inline_start` * `text_indent` * `font_size_modifier` * `vertical_align` The current status of the suggestion. **Available values:** * `open`: A suggestion was made, but it hasn't been accepted or rejected yet. * `accepted`: A suggestion was accepted and applied to the design. * `rejected`: A suggestion was rejected and not applied to the design. When the thread was created, as a Unix timestamp (in seconds since the Unix Epoch). When the thread was last updated, as a Unix timestamp (in seconds since the Unix Epoch). Metadata for the user, consisting of the User ID and display name. Properties of author}> The ID of the user. The name of the user as shown in the Canva UI. Event type for a comment thread that has been resolved. **Available values:** The only valid value is `resolved`. A URL to the design, focused on the comment thread. A discussion thread on a design. The `type` of the thread can be found in the `thread_type` object, along with additional type-specific properties. The `author` of the thread might be missing if that user account no longer exists. Properties of comment}> The ID of the thread. You can use this ID to create replies to the thread using the [Create reply API](https://www.canva.dev/docs/apps/rest-apis/reference/comments/create-reply/). The ID of the design that the discussion thread is on. The type of the discussion thread, along with additional type-specific properties. A comment thread. **Available values:** The only valid value is `comment`. The content of a comment thread or reply. Properties of content}> The content in plaintext. Any user mention tags are shown in the format `[user_id:team_id]`. The content in markdown. Any user mention tags are shown in the format `[user_id:team_id]` The Canva users mentioned in the comment thread or reply. Properties of mentions}> Information about the user mentioned in a comment thread or reply. Each user mention is keyed using the user's user ID and team ID separated by a colon (`user_id:team_id`). ```json { "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP": { "tag": "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP", "user": { "user_id": "oUnPjZ2k2yuhftbWF7873o", "team_id": "oBpVhLW22VrqtwKgaayRbP", "display_name": "John Doe" } } } ``` The mention tag for the user mentioned in the comment thread or reply content. This has the format of the user's user ID and team ID separated by a colon (`user_id:team_id`). Metadata for the user, consisting of the User ID, Team ID, and display name. Properties of user}> The ID of the user. The ID of the user's Canva Team. The name of the user as shown in the Canva UI. Metadata for the user, consisting of the User ID and display name. Properties of assignee}> The ID of the user. The name of the user as shown in the Canva UI. Metadata for the user, consisting of the User ID and display name. Properties of resolver}> The ID of the user. The name of the user as shown in the Canva UI. A suggestion thread. **Available values:** The only valid value is `suggestion`. The type of the suggested edit, along with additional type-specific properties. **Minimum items:** `1` A suggestion to add some text. **Available values:** The only valid value is `add`. A suggestion to delete some text. **Available values:** The only valid value is `delete`. A suggestion to format some text. **Available values:** The only valid value is `format`. The suggested format change. **Available values:** * `font_family` * `font_size` * `font_weight` * `font_style` * `color` * `background_color` * `decoration` * `strikethrough` * `link` * `letter_spacing` * `line_height` * `direction` * `text_align` * `list_marker` * `list_level` * `margin_inline_start` * `text_indent` * `font_size_modifier` * `vertical_align` The current status of the suggestion. **Available values:** * `open`: A suggestion was made, but it hasn't been accepted or rejected yet. * `accepted`: A suggestion was accepted and applied to the design. * `rejected`: A suggestion was rejected and not applied to the design. When the thread was created, as a Unix timestamp (in seconds since the Unix Epoch). When the thread was last updated, as a Unix timestamp (in seconds since the Unix Epoch). Metadata for the user, consisting of the User ID and display name. Properties of author}> The ID of the user. The name of the user as shown in the Canva UI. Event type for a reply to a comment thread. **Available values:** The only valid value is `reply`. A URL to the design, focused on the comment reply. A reply to a thread. The `author` of the reply might be missing if that user account no longer exists. Properties of reply}> The ID of the reply. The ID of the design that the thread for this reply is attached to. The ID of the thread this reply is in. The content of a comment thread or reply. Properties of content}> The content in plaintext. Any user mention tags are shown in the format `[user_id:team_id]`. The content in markdown. Any user mention tags are shown in the format `[user_id:team_id]` The Canva users mentioned in the comment thread or reply. Properties of mentions}> Information about the user mentioned in a comment thread or reply. Each user mention is keyed using the user's user ID and team ID separated by a colon (`user_id:team_id`). ```json { "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP": { "tag": "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP", "user": { "user_id": "oUnPjZ2k2yuhftbWF7873o", "team_id": "oBpVhLW22VrqtwKgaayRbP", "display_name": "John Doe" } } } ``` The mention tag for the user mentioned in the comment thread or reply content. This has the format of the user's user ID and team ID separated by a colon (`user_id:team_id`). Metadata for the user, consisting of the User ID, Team ID, and display name. Properties of user}> The ID of the user. The ID of the user's Canva Team. The name of the user as shown in the Canva UI. When the reply was created, as a Unix timestamp (in seconds since the Unix Epoch). When the reply was last updated, as a Unix timestamp (in seconds since the Unix Epoch). Metadata for the user, consisting of the User ID and display name. Properties of author}> The ID of the user. The name of the user as shown in the Canva UI. Event type for a mention in a comment thread or reply. **Available values:** The only valid value is `mention`. The type of mention event content, along with additional type-specific properties. Content for a mention in a comment thread. **Available values:** The only valid value is `thread`. A URL to the design, focused on the comment thread. A discussion thread on a design. The `type` of the thread can be found in the `thread_type` object, along with additional type-specific properties. The `author` of the thread might be missing if that user account no longer exists. Properties of comment}> The ID of the thread. You can use this ID to create replies to the thread using the [Create reply API](https://www.canva.dev/docs/apps/rest-apis/reference/comments/create-reply/). The ID of the design that the discussion thread is on. The type of the discussion thread, along with additional type-specific properties. A comment thread. **Available values:** The only valid value is `comment`. The content of a comment thread or reply. Properties of content}> The content in plaintext. Any user mention tags are shown in the format `[user_id:team_id]`. The content in markdown. Any user mention tags are shown in the format `[user_id:team_id]` The Canva users mentioned in the comment thread or reply. Properties of mentions}> Information about the user mentioned in a comment thread or reply. Each user mention is keyed using the user's user ID and team ID separated by a colon (`user_id:team_id`). ```json { "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP": { "tag": "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP", "user": { "user_id": "oUnPjZ2k2yuhftbWF7873o", "team_id": "oBpVhLW22VrqtwKgaayRbP", "display_name": "John Doe" } } } ``` The mention tag for the user mentioned in the comment thread or reply content. This has the format of the user's user ID and team ID separated by a colon (`user_id:team_id`). Metadata for the user, consisting of the User ID, Team ID, and display name. Properties of user}> The ID of the user. The ID of the user's Canva Team. The name of the user as shown in the Canva UI. Metadata for the user, consisting of the User ID and display name. Properties of assignee}> The ID of the user. The name of the user as shown in the Canva UI. Metadata for the user, consisting of the User ID and display name. Properties of resolver}> The ID of the user. The name of the user as shown in the Canva UI. A suggestion thread. **Available values:** The only valid value is `suggestion`. The type of the suggested edit, along with additional type-specific properties. **Minimum items:** `1` A suggestion to add some text. **Available values:** The only valid value is `add`. A suggestion to delete some text. **Available values:** The only valid value is `delete`. A suggestion to format some text. **Available values:** The only valid value is `format`. The suggested format change. **Available values:** * `font_family` * `font_size` * `font_weight` * `font_style` * `color` * `background_color` * `decoration` * `strikethrough` * `link` * `letter_spacing` * `line_height` * `direction` * `text_align` * `list_marker` * `list_level` * `margin_inline_start` * `text_indent` * `font_size_modifier` * `vertical_align` The current status of the suggestion. **Available values:** * `open`: A suggestion was made, but it hasn't been accepted or rejected yet. * `accepted`: A suggestion was accepted and applied to the design. * `rejected`: A suggestion was rejected and not applied to the design. When the thread was created, as a Unix timestamp (in seconds since the Unix Epoch). When the thread was last updated, as a Unix timestamp (in seconds since the Unix Epoch). Metadata for the user, consisting of the User ID and display name. Properties of author}> The ID of the user. The name of the user as shown in the Canva UI. Content for a mention in a comment reply. **Available values:** The only valid value is `reply`. A URL to the design, focused on the comment reply. A reply to a thread. The `author` of the reply might be missing if that user account no longer exists. Properties of reply}> The ID of the reply. The ID of the design that the thread for this reply is attached to. The ID of the thread this reply is in. The content of a comment thread or reply. Properties of content}> The content in plaintext. Any user mention tags are shown in the format `[user_id:team_id]`. The content in markdown. Any user mention tags are shown in the format `[user_id:team_id]` The Canva users mentioned in the comment thread or reply. Properties of mentions}> Information about the user mentioned in a comment thread or reply. Each user mention is keyed using the user's user ID and team ID separated by a colon (`user_id:team_id`). ```json { "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP": { "tag": "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP", "user": { "user_id": "oUnPjZ2k2yuhftbWF7873o", "team_id": "oBpVhLW22VrqtwKgaayRbP", "display_name": "John Doe" } } } ``` The mention tag for the user mentioned in the comment thread or reply content. This has the format of the user's user ID and team ID separated by a colon (`user_id:team_id`). Metadata for the user, consisting of the User ID, Team ID, and display name. Properties of user}> The ID of the user. The ID of the user's Canva Team. The name of the user as shown in the Canva UI. When the reply was created, as a Unix timestamp (in seconds since the Unix Epoch). When the reply was last updated, as a Unix timestamp (in seconds since the Unix Epoch). Metadata for the user, consisting of the User ID and display name. Properties of author}> The ID of the user. The name of the user as shown in the Canva UI. A URL to the design, focused on the new comment. The `comment_url` property is deprecated. For details of the comment event, use the `comment_event` property instead. Basic details about the comment. The `comment` property is deprecated. For details of the comment event, use the `comment_event` property instead. Properties of comment}> The type of comment event. **Available values:** * `comment` * `reply` * `mention` * `assign` * `resolve` The comment object, which contains metadata about the comment. Deprecated in favor of the new `thread` object. Data about the comment, including the message, author, and the object (such as a design) the comment is attached to. The type of comment. When creating a new parent (top-level) comment, the `type` is `parent`. **Available values:** The only valid value is `parent`. The ID of the comment. You can use this ID to create replies to the comment using the [Create reply API](https://www.canva.dev/docs/apps/rest-apis/reference/comments/create-reply/). The comment message. This is the comment body shown in the Canva UI. User mentions are shown here in the format `[user_id:team_id]`. Metadata for the user, consisting of the User ID and display name. Properties of author}> The ID of the user. The name of the user as shown in the Canva UI. When the comment or reply was created, as a Unix timestamp (in seconds since the Unix Epoch). When the comment or reply was last updated, as a Unix timestamp (in seconds since the Unix Epoch). Metadata for the user, consisting of the User ID and display name. Properties of assignee}> The ID of the user. The name of the user as shown in the Canva UI. Metadata for the user, consisting of the User ID and display name. Properties of resolver}> The ID of the user. The name of the user as shown in the Canva UI. The Canva users mentioned in the comment. Properties of mentions}> Metadata for the user, consisting of the User ID, Team ID, and display name. The ID of the user. The ID of the user's Canva Team. The name of the user as shown in the Canva UI. Identifying information about the object (such as a design) that the comment is attached to. If the comment is attached to a Canva Design. **Available values:** The only valid value is `design`. The ID of the design this comment is attached to. Data about the reply comment, including the message, author, and the object (such as a design) the comment is attached to. The type of comment. When creating a reply to a top-level comment, the `type` is `reply`. **Available values:** The only valid value is `reply`. The ID of the comment. The comment message. This is the comment body shown in the Canva UI. User mentions are shown here in the format `[user_id:team_id]`. Metadata for the user, consisting of the User ID and display name. Properties of author}> The ID of the user. The name of the user as shown in the Canva UI. The ID of the comment thread this reply is in. This ID is the same as the `id` of the parent comment. When the comment or reply was created, as a Unix timestamp (in seconds since the Unix Epoch). When the comment or reply was last updated, as a Unix timestamp (in seconds since the Unix Epoch). The Canva users mentioned in the comment. Properties of mentions}> Metadata for the user, consisting of the User ID, Team ID, and display name. The ID of the user. The ID of the user's Canva Team. The name of the user as shown in the Canva UI. Identifying information about the object (such as a design) that the comment is attached to. If the comment is attached to a Canva Design. **Available values:** The only valid value is `design`. The ID of the design this comment is attached to. ## Example: Comment notification