Skip navigation

Skip to main content

Webhook notifications
Collaborating
Webhook notifications

Comment notifications

The NotificationContent sent when a user comments on a design.

Webhook notifications are currently provided as a preview. Be aware of the following:

  • There might be unannounced breaking changes.
  • Any breaking changes to preview features won't produce a new API version.
  • Public integrations that use preview features will not pass the review process, and can't be made available to all Canva users.

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

typestring

Available values: The only valid value is comment.

triggering_userUser

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

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.

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.

idstring

The design ID.

urlsDesignLinks

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

edit_urlstring

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.

This is not a permanent URL, it is only valid for 30 days.

view_urlstring

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.

This is not a permanent URL, it is only valid for 30 days.

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.

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

comment_eventCommentEvent
Optional

The type of comment event, including additional type-specific properties.

typestring

This can be one of the following:

  • new: Event type for a new comment thread.
  • assigned: Event type for a comment thread that has been assigned.
  • resolved: Event type for a comment thread that has been resolved.
  • reply: Event type for a reply to a comment thread.
  • mention: Event type for a mention in a comment thread or reply.
comment_urlstring
Conditional

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

commentThread
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. The author of the thread might be missing if that user account no longer exists.

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.

typestring

This can be one of the following:

  • comment: A comment thread.
  • suggestion: A suggestion thread.
contentCommentContent
Conditional

The content of a comment thread or reply.

plaintextstring

The content in plaintext. Any user mention tags are shown in the format [user_id:team_id].

markdownstring
Optional

The content in markdown. Any user mention tags are shown in the format [user_id:team_id]

mentionsobject
Conditional

The Canva users mentioned in the comment thread or reply.

<KEY>object of UserMentions

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

{
  "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP": {
    "tag": "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP",
    "user": {
      "user_id": "oUnPjZ2k2yuhftbWF7873o",
      "team_id": "oBpVhLW22VrqtwKgaayRbP",
      "display_name": "John Doe"
    }
  }
}
JSON
tagstring

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

userTeamUser

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

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.

suggested_editsSuggestedEdit[]
Conditional

The type of the suggested edit, along with additional type-specific properties.

Minimum items: 1

typestring

This can be one of the following:

  • add: A suggestion to add some text.
  • delete: A suggestion to delete some text.
  • format: A suggestion to format some text.
textstring
Conditional
formatstring
Conditional

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
statusstring
Conditional

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

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

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.

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

authorUser
Optional

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

idstring

The ID of the user.

display_namestring
Optional

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

reply_urlstring
Conditional

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

replyReply
Conditional

A reply to a thread.

The author of the reply might be missing if that user account no longer exists.

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.

contentCommentContent

The content of a comment thread or reply.

plaintextstring

The content in plaintext. Any user mention tags are shown in the format [user_id:team_id].

markdownstring
Optional

The content in markdown. Any user mention tags are shown in the format [user_id:team_id]

mentionsobject

The Canva users mentioned in the comment thread or reply.

<KEY>object of UserMentions

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

{
  "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP": {
    "tag": "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP",
    "user": {
      "user_id": "oUnPjZ2k2yuhftbWF7873o",
      "team_id": "oBpVhLW22VrqtwKgaayRbP",
      "display_name": "John Doe"
    }
  }
}
JSON
tagstring

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

userTeamUser

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

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

authorUser
Optional

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

idstring

The ID of the user.

display_namestring
Optional

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

contentMentionEventContent
Conditional

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

typestring

This can be one of the following:

  • thread: Content for a mention in a comment thread.
  • reply: Content for a mention in a comment reply.
comment_urlstring
Conditional

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

commentThread
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. The author of the thread might be missing if that user account no longer exists.

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.

typestring

This can be one of the following:

  • comment: A comment thread.
  • suggestion: A suggestion thread.
contentCommentContent
Conditional

The content of a comment thread or reply.

plaintextstring

The content in plaintext. Any user mention tags are shown in the format [user_id:team_id].

markdownstring
Optional

The content in markdown. Any user mention tags are shown in the format [user_id:team_id]

mentionsobject
Conditional

The Canva users mentioned in the comment thread or reply.

<KEY>object of UserMentions

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

{
  "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP": {
    "tag": "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP",
    "user": {
      "user_id": "oUnPjZ2k2yuhftbWF7873o",
      "team_id": "oBpVhLW22VrqtwKgaayRbP",
      "display_name": "John Doe"
    }
  }
}
JSON
tagstring

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

userTeamUser

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

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.

suggested_editsSuggestedEdit[]
Conditional

The type of the suggested edit, along with additional type-specific properties.

Minimum items: 1

typestring

This can be one of the following:

  • add: A suggestion to add some text.
  • delete: A suggestion to delete some text.
  • format: A suggestion to format some text.
textstring
Conditional
formatstring
Conditional

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
statusstring
Conditional

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

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

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.

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

authorUser
Optional

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

idstring

The ID of the user.

display_namestring
Optional

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

reply_urlstring
Conditional

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

replyReply
Conditional

A reply to a thread.

The author of the reply might be missing if that user account no longer exists.

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.

contentCommentContent

The content of a comment thread or reply.

plaintextstring

The content in plaintext. Any user mention tags are shown in the format [user_id:team_id].

markdownstring
Optional

The content in markdown. Any user mention tags are shown in the format [user_id:team_id]

mentionsobject

The Canva users mentioned in the comment thread or reply.

<KEY>object of UserMentions

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

{
  "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP": {
    "tag": "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP",
    "user": {
      "user_id": "oUnPjZ2k2yuhftbWF7873o",
      "team_id": "oBpVhLW22VrqtwKgaayRbP",
      "display_name": "John Doe"
    }
  }
}
JSON
tagstring

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

userTeamUser

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

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

authorUser
Optional

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

idstring

The ID of the user.

display_namestring
Optional

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

comment_urlstring
Deprecated

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.

commentCommentEventDeprecated
Deprecated

Basic details about the comment.

The comment property is deprecated. For details of the comment event, use the comment_event property instead.

typestring

The type of comment event.

Available values:

  • comment
  • reply
  • mention
  • assign
  • resolve
dataComment

The comment object, which contains metadata about the comment. Deprecated in favor of the new thread object.

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.

idstring

The ID of the user.

display_namestring
Deprecated

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.

created_atinteger
Deprecated

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

updated_atinteger
Deprecated

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

assigneeUser
Deprecated

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

idstring

The ID of the user.

display_namestring
Deprecated

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

resolverUser
Deprecated

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

idstring

The ID of the user.

display_namestring
Deprecated

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

mentionsobject

The Canva users mentioned in the comment.

<KEY>object of TeamUsers

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

user_idstring
Deprecated

The ID of the user.

team_idstring
Deprecated

The ID of the user's Canva Team.

display_namestring
Deprecated

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

attached_toCommentObject
Deprecated

Identifying information about the object (such as a design) that the comment is 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.

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/eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIiwiZXhwaXJ5IjoxNzQyMDk5NDAzMDc5fQ..GKLx2hrJa3wSSDKQ.hk3HA59qJyxehR-ejzt2DThBW0cbRdMBz7Fb5uCpwD-4o485pCf4kcXt_ypUYX0qMHVeZ131YvfwGPIhbk-C245D8c12IIJSDbZUZTS7WiCOJZQ.sNz3mPSQxsETBvl_-upMYA/edit",
        "view_url": "https://www.canva.com/api/design/eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIiwiZXhwaXJ5IjoxNzQyMDk5NDAzMDc5fQ..GKLx2hrJa3wSSDKQ.hk3HA59qJyxehR-ejzt2DThBW0cbRdMBz7Fb5uCpwD-4o485pCf4kcXt_ypUYX0qMHVeZ131YvfwGPIhbk-C245D8c12IIJSDbZUZTS7WiCOJZQ.sNz3mPSQxsETBvl_-upMYA/view"
      },
      "created_at": 1377396000,
      "updated_at": 1692928800,
      "page_count": 3
    },
    "comment_event": {
      "type": "new",
      "comment_url": "https://www.canva.com/design/3WCduQdjayTcPVM/z128cqanFu7E3/edit?ui=OdllGgZ4Snnq3MD8uI10bfA",
      "comment": {
        "id": "KeAbiEAjZEj",
        "design_id": "DAFVztcvd9z",
        "thread_type": {
          "type": "comment",
          "content": {
            "plaintext": "Great work [oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP]!",
            "markdown": "*_Great work_* [oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP]!"
          },
          "mentions": {
            "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP": {
              "tag": "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP",
              "user": {
                "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