Appearance
Suggestion notifications
The NotificationContent sent when a user suggests an edit to a design.
If the type of notification is suggestion, the webhook payload object contains the following parameters:
<Prop.List> <Prop name="id" type="string" required mode="output"> The unique identifier for the notification. </Prop>
<Prop name="created_at" type="integer" required mode="output"> When the notification was created, as a UNIX timestamp (in seconds since the UNIX epoch). </Prop>
<Prop name="content" type="object" required mode="output"> The notification content when someone does one of the following actions:
* Suggests edits to a design.
* Applies or rejects a suggestion.
* Replies to a suggestion.
* Mentions a user in a reply to a suggestion.
<PillAccordion title={<>Properties of <strong>content</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Available values:** The only valid value is `suggestion`.
</Prop.Extras>
</Prop>
<Prop name="triggering_user" type="User" required mode="output">
Metadata for the user, consisting of the User ID and display name.
<PillAccordion title={<>Properties of <strong>triggering_user</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The ID of the user.
</Prop>
<Prop name="display_name" type="string" mode="output">
The name of the user as shown in the Canva UI.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="receiving_team_user" type="TeamUser" required mode="output">
Metadata for the user, consisting of the User ID, Team ID, and display name.
<PillAccordion title={<>Properties of <strong>receiving_team_user</strong></>}>
<Prop.List>
<Prop name="user_id" type="string" mode="output">
The ID of the user.
</Prop>
<Prop name="team_id" type="string" mode="output">
The ID of the user's Canva Team.
</Prop>
<Prop name="display_name" type="string" mode="output">
The name of the user as shown in the Canva UI.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="design" type="DesignSummary" required mode="output">
Basic details about the design, such as the design's ID, title, and URL.
<PillAccordion title={<>Properties of <strong>design</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The design ID.
</Prop>
<Prop name="urls" type="DesignLinks" required mode="output">
A temporary set of URLs for viewing or editing the design.
<PillAccordion title={<>Properties of <strong>urls</strong></>}>
<Prop.List>
<Prop name="edit_url" type="string" required mode="output">
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 workflows.
NOTE: This is not a permanent URL, it is only valid for 30 days.
</Prop>
<Prop name="view_url" type="string" required mode="output">
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 workflows.
NOTE: This is not a permanent URL, it is only valid for 30 days.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="created_at" type="integer" required mode="output">
When the design was created in Canva, as a Unix timestamp (in seconds since the Unix
Epoch).
</Prop>
<Prop name="updated_at" type="integer" required mode="output">
When the design was last updated in Canva, as a Unix timestamp (in seconds since the
Unix Epoch).
</Prop>
<Prop name="title" type="string" mode="output">
The design title.
</Prop>
<Prop name="url" type="string" mode="output">
URL of the design.
</Prop>
<Prop name="thumbnail" type="Thumbnail" mode="output">
A thumbnail image representing the object.
<PillAccordion title={<>Properties of <strong>thumbnail</strong></>}>
<Prop.List>
<Prop name="width" type="integer" required mode="output">
The width of the thumbnail image in pixels.
</Prop>
<Prop name="height" type="integer" required mode="output">
The height of the thumbnail image in pixels.
</Prop>
<Prop name="url" type="string" required mode="output">
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.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="page_count" type="integer" mode="output">
The total number of pages in the design. Some design types don't have pages (for example, Canva docs).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="suggestion_event_type" type="SuggestionEventType" required mode="output">
The type of suggestion event, along with additional type-specific properties.
<Tabs>
<Tab name="new">
Event type for a new suggestion.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Available values:** The only valid value is `new`.
</Prop.Extras>
</Prop>
<Prop name="suggestion_url" type="string" required mode="output">
A URL to the design, focused on the suggestion.
</Prop>
<Prop name="suggestion" type="Thread" required mode="output">
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.
<PillAccordion title={<>Properties of <strong>suggestion</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The ID of the thread.
You can use this ID to create replies to the thread using the Create reply API.
</Prop>
<Prop name="design_id" type="string" required mode="output">
The ID of the design that the discussion thread is on.
</Prop>
<Prop name="thread_type" type="ThreadType" required mode="output">
The type of the discussion thread, along with additional type-specific properties.
<Tabs>
<Tab name="comment">
A comment thread.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Available values:** The only valid value is `comment`.
</Prop.Extras>
</Prop>
<Prop name="content" type="CommentContent" required mode="output">
The content of a comment thread or reply.
<PillAccordion title={<>Properties of <strong>content</strong></>}>
<Prop.List>
<Prop name="plaintext" type="string" required mode="output">
The content in plaintext.
Any user mention tags are shown in the format `[user_id:team_id]`.
</Prop>
<Prop name="markdown" type="string" mode="output">
The content in markdown.
Any user mention tags are shown in the format `[user_id:team_id]`
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="mentions" type="object" required mode="output">
The Canva users mentioned in the comment thread or reply.
<PillAccordion title={<>Properties of <strong>mentions</strong></>}>
<Prop.List>
<Prop name="<KEY>" type="object of UserMentions" mode="output" required required>
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"
}
}
}
```
<Prop.List>
<Prop name="tag" type="string" required mode="output">
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`).
</Prop>
<Prop name="user" type="TeamUser" required mode="output">
Metadata for the user, consisting of the User ID, Team ID, and display name.
<PillAccordion title={<>Properties of <strong>user</strong></>}>
<Prop.List>
<Prop name="user_id" type="string" mode="output">
The ID of the user.
</Prop>
<Prop name="team_id" type="string" mode="output">
The ID of the user's Canva Team.
</Prop>
<Prop name="display_name" type="string" mode="output">
The name of the user as shown in the Canva UI.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="assignee" type="User" mode="output">
Metadata for the user, consisting of the User ID and display name.
<PillAccordion title={<>Properties of <strong>assignee</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The ID of the user.
</Prop>
<Prop name="display_name" type="string" mode="output">
The name of the user as shown in the Canva UI.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="resolver" type="User" mode="output">
Metadata for the user, consisting of the User ID and display name.
<PillAccordion title={<>Properties of <strong>resolver</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The ID of the user.
</Prop>
<Prop name="display_name" type="string" mode="output">
The name of the user as shown in the Canva UI.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="suggestion">
A suggestion thread.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Available values:** The only valid value is `suggestion`.
</Prop.Extras>
</Prop>
<Prop name="suggested_edits" type="SuggestedEdit[]" required mode="output">
The type of the suggested edit, along with additional type-specific properties.
<Prop.Extras>
**Minimum items:** `1`
</Prop.Extras>
<Tabs>
<Tab name="add">
A suggestion to add some text.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Available values:** The only valid value is `add`.
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
<Tab name="delete">
A suggestion to delete some text.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Available values:** The only valid value is `delete`.
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
<Tab name="format">
A suggestion to format some text.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Available values:** The only valid value is `format`.
</Prop.Extras>
</Prop>
<Prop name="format" type="string" required mode="output">
The suggested format change.
<Prop.Extras>
**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`
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop>
<Prop name="status" type="string" required mode="output">
The current status of the suggestion.
<Prop.Extras>
**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.
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop>
<Prop name="created_at" type="integer" required mode="output">
When the thread was created, as a Unix timestamp
(in seconds since the Unix Epoch).
</Prop>
<Prop name="updated_at" type="integer" required mode="output">
When the thread was last updated, as a Unix timestamp
(in seconds since the Unix Epoch).
</Prop>
<Prop name="author" type="User" mode="output">
Metadata for the user, consisting of the User ID and display name.
<PillAccordion title={<>Properties of <strong>author</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The ID of the user.
</Prop>
<Prop name="display_name" type="string" mode="output">
The name of the user as shown in the Canva UI.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="accepted">
Event type for a suggestion that has been accepted.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Available values:** The only valid value is `accepted`.
</Prop.Extras>
</Prop>
<Prop name="suggestion_url" type="string" required mode="output">
A URL to the design, focused on the suggestion.
</Prop>
<Prop name="suggestion" type="Thread" required mode="output">
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.
<PillAccordion title={<>Properties of <strong>suggestion</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The ID of the thread.
You can use this ID to create replies to the thread using the Create reply API.
</Prop>
<Prop name="design_id" type="string" required mode="output">
The ID of the design that the discussion thread is on.
</Prop>
<Prop name="thread_type" type="ThreadType" required mode="output">
The type of the discussion thread, along with additional type-specific properties.
<Tabs>
<Tab name="comment">
A comment thread.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Available values:** The only valid value is `comment`.
</Prop.Extras>
</Prop>
<Prop name="content" type="CommentContent" required mode="output">
The content of a comment thread or reply.
<PillAccordion title={<>Properties of <strong>content</strong></>}>
<Prop.List>
<Prop name="plaintext" type="string" required mode="output">
The content in plaintext.
Any user mention tags are shown in the format `[user_id:team_id]`.
</Prop>
<Prop name="markdown" type="string" mode="output">
The content in markdown.
Any user mention tags are shown in the format `[user_id:team_id]`
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="mentions" type="object" required mode="output">
The Canva users mentioned in the comment thread or reply.
<PillAccordion title={<>Properties of <strong>mentions</strong></>}>
<Prop.List>
<Prop name="<KEY>" type="object of UserMentions" mode="output" required required>
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"
}
}
}
```
<Prop.List>
<Prop name="tag" type="string" required mode="output">
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`).
</Prop>
<Prop name="user" type="TeamUser" required mode="output">
Metadata for the user, consisting of the User ID, Team ID, and display name.
<PillAccordion title={<>Properties of <strong>user</strong></>}>
<Prop.List>
<Prop name="user_id" type="string" mode="output">
The ID of the user.
</Prop>
<Prop name="team_id" type="string" mode="output">
The ID of the user's Canva Team.
</Prop>
<Prop name="display_name" type="string" mode="output">
The name of the user as shown in the Canva UI.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="assignee" type="User" mode="output">
Metadata for the user, consisting of the User ID and display name.
<PillAccordion title={<>Properties of <strong>assignee</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The ID of the user.
</Prop>
<Prop name="display_name" type="string" mode="output">
The name of the user as shown in the Canva UI.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="resolver" type="User" mode="output">
Metadata for the user, consisting of the User ID and display name.
<PillAccordion title={<>Properties of <strong>resolver</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The ID of the user.
</Prop>
<Prop name="display_name" type="string" mode="output">
The name of the user as shown in the Canva UI.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="suggestion">
A suggestion thread.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Available values:** The only valid value is `suggestion`.
</Prop.Extras>
</Prop>
<Prop name="suggested_edits" type="SuggestedEdit[]" required mode="output">
The type of the suggested edit, along with additional type-specific properties.
<Prop.Extras>
**Minimum items:** `1`
</Prop.Extras>
<Tabs>
<Tab name="add">
A suggestion to add some text.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Available values:** The only valid value is `add`.
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
<Tab name="delete">
A suggestion to delete some text.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Available values:** The only valid value is `delete`.
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
<Tab name="format">
A suggestion to format some text.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Available values:** The only valid value is `format`.
</Prop.Extras>
</Prop>
<Prop name="format" type="string" required mode="output">
The suggested format change.
<Prop.Extras>
**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`
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop>
<Prop name="status" type="string" required mode="output">
The current status of the suggestion.
<Prop.Extras>
**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.
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop>
<Prop name="created_at" type="integer" required mode="output">
When the thread was created, as a Unix timestamp
(in seconds since the Unix Epoch).
</Prop>
<Prop name="updated_at" type="integer" required mode="output">
When the thread was last updated, as a Unix timestamp
(in seconds since the Unix Epoch).
</Prop>
<Prop name="author" type="User" mode="output">
Metadata for the user, consisting of the User ID and display name.
<PillAccordion title={<>Properties of <strong>author</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The ID of the user.
</Prop>
<Prop name="display_name" type="string" mode="output">
The name of the user as shown in the Canva UI.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="rejected">
Event type for a suggestion that has been rejected.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Available values:** The only valid value is `rejected`.
</Prop.Extras>
</Prop>
<Prop name="suggestion_url" type="string" required mode="output">
A URL to the design, focused on the suggestion.
</Prop>
<Prop name="suggestion" type="Thread" required mode="output">
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.
<PillAccordion title={<>Properties of <strong>suggestion</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The ID of the thread.
You can use this ID to create replies to the thread using the Create reply API.
</Prop>
<Prop name="design_id" type="string" required mode="output">
The ID of the design that the discussion thread is on.
</Prop>
<Prop name="thread_type" type="ThreadType" required mode="output">
The type of the discussion thread, along with additional type-specific properties.
<Tabs>
<Tab name="comment">
A comment thread.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Available values:** The only valid value is `comment`.
</Prop.Extras>
</Prop>
<Prop name="content" type="CommentContent" required mode="output">
The content of a comment thread or reply.
<PillAccordion title={<>Properties of <strong>content</strong></>}>
<Prop.List>
<Prop name="plaintext" type="string" required mode="output">
The content in plaintext.
Any user mention tags are shown in the format `[user_id:team_id]`.
</Prop>
<Prop name="markdown" type="string" mode="output">
The content in markdown.
Any user mention tags are shown in the format `[user_id:team_id]`
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="mentions" type="object" required mode="output">
The Canva users mentioned in the comment thread or reply.
<PillAccordion title={<>Properties of <strong>mentions</strong></>}>
<Prop.List>
<Prop name="<KEY>" type="object of UserMentions" mode="output" required required>
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"
}
}
}
```
<Prop.List>
<Prop name="tag" type="string" required mode="output">
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`).
</Prop>
<Prop name="user" type="TeamUser" required mode="output">
Metadata for the user, consisting of the User ID, Team ID, and display name.
<PillAccordion title={<>Properties of <strong>user</strong></>}>
<Prop.List>
<Prop name="user_id" type="string" mode="output">
The ID of the user.
</Prop>
<Prop name="team_id" type="string" mode="output">
The ID of the user's Canva Team.
</Prop>
<Prop name="display_name" type="string" mode="output">
The name of the user as shown in the Canva UI.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="assignee" type="User" mode="output">
Metadata for the user, consisting of the User ID and display name.
<PillAccordion title={<>Properties of <strong>assignee</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The ID of the user.
</Prop>
<Prop name="display_name" type="string" mode="output">
The name of the user as shown in the Canva UI.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="resolver" type="User" mode="output">
Metadata for the user, consisting of the User ID and display name.
<PillAccordion title={<>Properties of <strong>resolver</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The ID of the user.
</Prop>
<Prop name="display_name" type="string" mode="output">
The name of the user as shown in the Canva UI.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="suggestion">
A suggestion thread.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Available values:** The only valid value is `suggestion`.
</Prop.Extras>
</Prop>
<Prop name="suggested_edits" type="SuggestedEdit[]" required mode="output">
The type of the suggested edit, along with additional type-specific properties.
<Prop.Extras>
**Minimum items:** `1`
</Prop.Extras>
<Tabs>
<Tab name="add">
A suggestion to add some text.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Available values:** The only valid value is `add`.
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
<Tab name="delete">
A suggestion to delete some text.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Available values:** The only valid value is `delete`.
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
<Tab name="format">
A suggestion to format some text.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Available values:** The only valid value is `format`.
</Prop.Extras>
</Prop>
<Prop name="format" type="string" required mode="output">
The suggested format change.
<Prop.Extras>
**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`
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop>
<Prop name="status" type="string" required mode="output">
The current status of the suggestion.
<Prop.Extras>
**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.
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop>
<Prop name="created_at" type="integer" required mode="output">
When the thread was created, as a Unix timestamp
(in seconds since the Unix Epoch).
</Prop>
<Prop name="updated_at" type="integer" required mode="output">
When the thread was last updated, as a Unix timestamp
(in seconds since the Unix Epoch).
</Prop>
<Prop name="author" type="User" mode="output">
Metadata for the user, consisting of the User ID and display name.
<PillAccordion title={<>Properties of <strong>author</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The ID of the user.
</Prop>
<Prop name="display_name" type="string" mode="output">
The name of the user as shown in the Canva UI.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="reply">
Event type for a reply to a suggestion.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Available values:** The only valid value is `reply`.
</Prop.Extras>
</Prop>
<Prop name="reply_url" type="string" required mode="output">
A URL to the design, focused on the suggestion reply.
</Prop>
<Prop name="reply" type="Reply" required mode="output">
A reply to a thread.
The `author` of the reply might be missing if that user account no longer exists.
<PillAccordion title={<>Properties of <strong>reply</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The ID of the reply.
</Prop>
<Prop name="design_id" type="string" required mode="output">
The ID of the design that the thread for this reply is attached to.
</Prop>
<Prop name="thread_id" type="string" required mode="output">
The ID of the thread this reply is in.
</Prop>
<Prop name="content" type="CommentContent" required mode="output">
The content of a comment thread or reply.
<PillAccordion title={<>Properties of <strong>content</strong></>}>
<Prop.List>
<Prop name="plaintext" type="string" required mode="output">
The content in plaintext.
Any user mention tags are shown in the format `[user_id:team_id]`.
</Prop>
<Prop name="markdown" type="string" mode="output">
The content in markdown.
Any user mention tags are shown in the format `[user_id:team_id]`
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="mentions" type="object" required mode="output">
The Canva users mentioned in the comment thread or reply.
<PillAccordion title={<>Properties of <strong>mentions</strong></>}>
<Prop.List>
<Prop name="<KEY>" type="object of UserMentions" mode="output" required required>
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"
}
}
}
```
<Prop.List>
<Prop name="tag" type="string" required mode="output">
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`).
</Prop>
<Prop name="user" type="TeamUser" required mode="output">
Metadata for the user, consisting of the User ID, Team ID, and display name.
<PillAccordion title={<>Properties of <strong>user</strong></>}>
<Prop.List>
<Prop name="user_id" type="string" mode="output">
The ID of the user.
</Prop>
<Prop name="team_id" type="string" mode="output">
The ID of the user's Canva Team.
</Prop>
<Prop name="display_name" type="string" mode="output">
The name of the user as shown in the Canva UI.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="created_at" type="integer" required mode="output">
When the reply was created, as a Unix timestamp
(in seconds since the Unix Epoch).
</Prop>
<Prop name="updated_at" type="integer" required mode="output">
When the reply was last updated, as a Unix timestamp
(in seconds since the Unix Epoch).
</Prop>
<Prop name="author" type="User" mode="output">
Metadata for the user, consisting of the User ID and display name.
<PillAccordion title={<>Properties of <strong>author</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The ID of the user.
</Prop>
<Prop name="display_name" type="string" mode="output">
The name of the user as shown in the Canva UI.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="mention">
Event type for a mention in a reply to a suggestion.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Available values:** The only valid value is `mention`.
</Prop.Extras>
</Prop>
<Prop name="reply_url" type="string" required mode="output">
A URL to the design, focused on the suggestion reply.
</Prop>
<Prop name="reply" type="Reply" required mode="output">
A reply to a thread.
The `author` of the reply might be missing if that user account no longer exists.
<PillAccordion title={<>Properties of <strong>reply</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The ID of the reply.
</Prop>
<Prop name="design_id" type="string" required mode="output">
The ID of the design that the thread for this reply is attached to.
</Prop>
<Prop name="thread_id" type="string" required mode="output">
The ID of the thread this reply is in.
</Prop>
<Prop name="content" type="CommentContent" required mode="output">
The content of a comment thread or reply.
<PillAccordion title={<>Properties of <strong>content</strong></>}>
<Prop.List>
<Prop name="plaintext" type="string" required mode="output">
The content in plaintext.
Any user mention tags are shown in the format `[user_id:team_id]`.
</Prop>
<Prop name="markdown" type="string" mode="output">
The content in markdown.
Any user mention tags are shown in the format `[user_id:team_id]`
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="mentions" type="object" required mode="output">
The Canva users mentioned in the comment thread or reply.
<PillAccordion title={<>Properties of <strong>mentions</strong></>}>
<Prop.List>
<Prop name="<KEY>" type="object of UserMentions" mode="output" required required>
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"
}
}
}
```
<Prop.List>
<Prop name="tag" type="string" required mode="output">
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`).
</Prop>
<Prop name="user" type="TeamUser" required mode="output">
Metadata for the user, consisting of the User ID, Team ID, and display name.
<PillAccordion title={<>Properties of <strong>user</strong></>}>
<Prop.List>
<Prop name="user_id" type="string" mode="output">
The ID of the user.
</Prop>
<Prop name="team_id" type="string" mode="output">
The ID of the user's Canva Team.
</Prop>
<Prop name="display_name" type="string" mode="output">
The name of the user as shown in the Canva UI.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="created_at" type="integer" required mode="output">
When the reply was created, as a Unix timestamp
(in seconds since the Unix Epoch).
</Prop>
<Prop name="updated_at" type="integer" required mode="output">
When the reply was last updated, as a Unix timestamp
(in seconds since the Unix Epoch).
</Prop>
<Prop name="author" type="User" mode="output">
Metadata for the user, consisting of the User ID and display name.
<PillAccordion title={<>Properties of <strong>author</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The ID of the user.
</Prop>
<Prop name="display_name" type="string" mode="output">
The name of the user as shown in the Canva UI.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop>
</Prop.List>
</PillAccordion>
</Prop> </Prop.List>