Skip navigation
Skip to main content
Webhook notifications
Collaborating
Webhook notifications

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:

#idstring

The unique identifier for the notification.

#created_atinteger

When the notification was created, as a UNIX timestamp (in seconds since the UNIX epoch).

#contentobject

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.
Properties of content
#typestring

The value for this can only be suggestion.

#triggering_userUser

Metadata for the user, consisting of the User ID and display name.

Properties of triggering_user
#idstring

The ID of the user.

#display_namestring
Optional

The name of the user as shown in the Canva UI.

#receiving_team_userTeamUser

Metadata for the user, consisting of the User ID, Team ID, and display name.

Properties of receiving_team_user
#user_idstring
Optional

The ID of the user.

#team_idstring
Optional

The ID of the user's Canva Team.

#display_namestring
Optional

The name of the user as shown in the Canva UI.

#designDesignSummary

Basic details about the design, such as the design's ID, title, and URL.

Properties of design
#idstring

The design ID.

#urlsDesignLinks

A temporary set of URLs for viewing or editing the design.

Properties of urls
#edit_urlstring

A temporary editing URL for the design.

#view_urlstring

A temporary viewing URL for the design.

#created_atinteger

When the design was created in Canva, as a Unix timestamp (in seconds since the Unix Epoch).

#updated_atinteger

When the design was last updated in Canva, as a Unix timestamp (in seconds since the Unix Epoch).

#titlestring
Optional

The design title.

#urlstring
Optional

URL of the design.

#thumbnailThumbnail
Optional

A thumbnail image representing the object.

Properties of thumbnail
#widthinteger

The width of the thumbnail image in pixels.

#heightinteger

The height of the thumbnail image in pixels.

#urlstring

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.

#page_countinteger
Optional

The total number of pages in the design. Some design types don't have pages (for example, Canva docs).

#suggestion_event_typeSuggestionEventType

The type of suggestion event, along with additional type-specific properties.

Properties of suggestion_event_type
#typestring

This can be one of the following:

  • new: Event type for a new suggestion.
  • accepted: Event type for a suggestion that has been accepted.
  • rejected: Event type for a suggestion that has been rejected.
  • reply: Event type for a reply to a suggestion.
  • mention: Event type for a mention in a reply to a suggestion.
#suggestion_urlstring
Conditional

A URL to the design, focused on the suggestion.

#suggestionThread
Conditional

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.

Properties of suggestion
#idstring

The ID of the thread.

You can use this ID to create replies to the thread using the Create reply API.

#design_idstring

The ID of the design that the discussion thread is on.

#thread_typeThreadType

The type of the discussion thread, along with additional type-specific properties.

Properties of thread_type
#typestring

This can be one of the following:

  • comment: A comment thread.
  • suggestion: A suggestion thread.
#messagestring
Conditional

The comment's message. Any user mentions are shown in the format [user_id:team_id].

#mentionsobject
Conditional

The Canva users mentioned in the comment.

Properties of mentions
#<KEY>object of TeamUsers

Metadata for the user, consisting of the User ID, Team ID, and display name.

{
  "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP": {
    "user_id": "oUnPjZ2k2yuhftbWF7873o",
    "team_id": "oBpVhLW22VrqtwKgaayRbP",
    "display_name": "John Doe"
  }
}
json
#user_idstring
Optional

The ID of the user.

#team_idstring
Optional

The ID of the user's Canva Team.

#display_namestring
Optional

The name of the user as shown in the Canva UI.

#contentSuggestionContent
Conditional

The suggestion's content.

Properties of content
#typestring

This can be one of the following:

  • add: A suggestion to add some text.
  • delete: A suggestion to delete some text.
  • replace: A suggestion to replace some text.
  • format: A suggestion to format some text.
#addstring
Conditional
#deletestring
Conditional
#formatsstring[]
Conditional

This can be an array of the following:

  • font_family
  • font_size
  • font_weight
  • font_style
  • color
  • decoration
  • strikethrough
  • link
  • letter_spacing
  • line_height
  • direction
  • text_align
  • list_marker
  • list_level
  • margin_inline_start
  • text_indent
#statusstring
Conditional

The current status of the suggestion. This can be one of the following:

  • 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.
#assigneeUser
Optional

Metadata for the user, consisting of the User ID and display name.

Properties of assignee
#idstring

The ID of the user.

#display_namestring
Optional

The name of the user as shown in the Canva UI.

#resolverUser
Optional

Metadata for the user, consisting of the User ID and display name.

Properties of resolver
#idstring

The ID of the user.

#display_namestring
Optional

The name of the user as shown in the Canva UI.

#authorUser

Metadata for the user, consisting of the User ID and display name.

Properties of author
#idstring

The ID of the user.

#display_namestring
Optional

The name of the user as shown in the Canva UI.

#created_atinteger

When the thread was created, as a Unix timestamp (in seconds since the Unix Epoch).

#updated_atinteger

When the thread was last updated, as a Unix timestamp (in seconds since the Unix Epoch).

#reply_urlstring
Conditional

A URL to the design, focused on the suggestion reply.

#replyReply
Conditional

A reply to a thread.

Properties of reply
#idstring

The ID of the reply.

#design_idstring

The ID of the design that the thread for this reply is attached to.

#thread_idstring

The ID of the thread this reply is in.

#authorUser

Metadata for the user, consisting of the User ID and display name.

Properties of author
#idstring

The ID of the user.

#display_namestring
Optional

The name of the user as shown in the Canva UI.

#messagestring

The reply's message. Any user mentions are shown in the format [user_id:team_id]

#mentionsobject

The Canva users mentioned in the comment.

Properties of mentions
#<KEY>object of TeamUsers

Metadata for the user, consisting of the User ID, Team ID, and display name.

{
  "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP": {
    "user_id": "oUnPjZ2k2yuhftbWF7873o",
    "team_id": "oBpVhLW22VrqtwKgaayRbP",
    "display_name": "John Doe"
  }
}
json
#user_idstring
Optional

The ID of the user.

#team_idstring
Optional

The ID of the user's Canva Team.

#display_namestring
Optional

The name of the user as shown in the Canva UI.

#created_atinteger

When the reply was created, as a Unix timestamp (in seconds since the Unix Epoch).

#updated_atinteger

When the reply was last updated, as a Unix timestamp (in seconds since the Unix Epoch).

Example: Suggestion notification

{
  "id": "eb595730",
  "created_at": 1377396000,
  "content": {
    "type": "suggestion",
    "triggering_user": {
      "id": "uKakKUfI03Fg8k2gZ6OkT",
      "display_name": "John Doe"
    },
    "receiving_team_user": {
      "user_id": "auDAbliZ2rQNNOsUl5OLu",
      "team_id": "Oi2RJILTrKk0KRhRUZozX",
      "display_name": "Jane Doe"
    },
    "design": {
      "id": "DAFVztcvd9z",
      "title": "My summer holiday",
      "url": "https://www.canva.com/design/DAFVztcvd9z/edit",
      "thumbnail": {
        "width": 595,
        "height": 335,
        "url": "https://document-export.canva.com/Vczz9/zF9vzVtdADc/2/thumbnail/0001.png?<query-string>"
      },
      "urls": {
        "edit_url": "https://www.canva.com/api/design/{token}/edit",
        "view_url": "https://www.canva.com/api/design/{token}/view"
      },
      "created_at": 1377396000,
      "updated_at": 1692928800,
      "page_count": 3
    },
    "suggestion_event_type": {
      "type": "new",
      "suggestion_url": "https://www.canva.com/design/3WCduQdjayTcPVM/z128cqanFu7E3/edit?ui=OdllGgZ4Snnq3MD8uI10bfA",
      "suggestion": {
        "id": "KeAbiEAjZEj",
        "design_id": "DAFVztcvd9z",
        "thread_type": {
          "type": "comment",
          "message": "Great work [oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP]!",
          "mentions": {
            "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP": {
              "user_id": "oUnPjZ2k2yuhftbWF7873o",
              "team_id": "oBpVhLW22VrqtwKgaayRbP",
              "display_name": "John Doe"
            }
          },
          "assignee": {
            "id": "uKakKUfI03Fg8k2gZ6OkT",
            "display_name": "John Doe"
          },
          "resolver": {
            "id": "uKakKUfI03Fg8k2gZ6OkT",
            "display_name": "John Doe"
          }
        },
        "author": {
          "id": "uKakKUfI03Fg8k2gZ6OkT",
          "display_name": "John Doe"
        },
        "created_at": 1692928800,
        "updated_at": 1692928900
      }
    }
  }
}
json