Skip navigation
Skip to main content
Webhook notifications
Collaborating
Webhook notifications

Comment notifications

The NotificationContent sent when a user comments on a design.

If the type of notification is comment, 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 for when someone comments on a design.

Properties of content
#typestring

The value for this can only be comment.

#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.

#comment_urlstring

A URL to the design, focused on the new comment.

#commentCommentEvent

Basic details about the comment.

Properties of comment
#typestring

The type of comment event. This can be one of the following:

  • comment
  • reply
  • mention
  • assign
  • resolve
#dataComment

The comment object, which contains metadata about the comment.

Properties of data
#typestring

This can be one of the following:

  • parent: The type of comment. When creating a new parent (top-level) comment, the type is parent.
  • reply: The type of comment. When creating a reply to a top-level comment, the type is reply.
#idstring

The ID of the comment.

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

#messagestring

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].

#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.

#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.

#thread_idstring
Conditional

The ID of the comment thread this reply is in. This ID is the same as the id of the parent comment.

#attached_toCommentObject
Optional

Identifying information about the object (such as a design) that the comment is attached to.

Properties of attached_to
#typestring

This can be one of the following:

  • design: If the comment is attached to a Canva Design.
#design_idstring

The ID of the design this comment is attached to.

#created_atinteger
Optional

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

#updated_atinteger
Optional

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

#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.

Example: Comment notification

{
  "id": "eb595730",
  "created_at": 1377396000,
  "content": {
    "type": "comment",
    "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
    },
    "comment_url": "https://www.canva.com/design/3WCduQdjayTcPVM/z128cqanFu7E3/edit?ui=OdllGgZ4Snnq3MD8uI10bfA",
    "comment": {
      "type": "comment",
      "data": {
        "type": "parent",
        "id": "KeAbiEAjZEj",
        "attached_to": {
          "design_id": "DAFVztcvd9z",
          "type": "design"
        },
        "message": "Great work [oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP]!",
        "author": {
          "id": "uKakKUfI03Fg8k2gZ6OkT",
          "display_name": "John Doe"
        },
        "created_at": 1692928800,
        "updated_at": 1692928900,
        "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"
        }
      }
    }
  }
}
json