Skip navigation

Skip to main content

Webhook notifications
Collaborating
Webhook notifications

Share folder notifications

The NotificationContent sent when a user shares a folder.

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.

If the type of notification is share_folder, 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 shares a folder.

Properties of content
typestring

The value for this can only be share_folder.

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.

folderFolderSummary

This object contains some folder metadata. You can retrieve additional metadata using the folder ID and the /v1/folders/{folderId} endpoint.

Properties of folder
idstring

The folder ID.

namestring

The folder name, as shown in the Canva UI.

created_atinteger

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

updated_atinteger

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

urlstring
OPTIONAL

The folder URL.

titlestring
DEPRECATED

The folder name, as shown in the Canva UI. This property is deprecated, so you should use the name property instead.

shareShareAction
OPTIONAL

Metadata about the share event.

Properties of share
messagestring

The optional message users can include when sharing something with another user using the Canva UI.

Example: Share folder notification

{
  "id": "eb595730",
  "created_at": 1377396000,
  "content": {
    "type": "share_folder",
    "triggering_user": {
      "id": "uKakKUfI03Fg8k2gZ6OkT",
      "display_name": "John Doe"
    },
    "receiving_team_user": {
      "user_id": "auDAbliZ2rQNNOsUl5OLu",
      "team_id": "Oi2RJILTrKk0KRhRUZozX",
      "display_name": "Jane Doe"
    },
    "folder": {
      "id": "FAF2lZtloor",
      "name": "My awesome holiday",
      "created_at": 1377396000,
      "updated_at": 1692928800,
      "url": "https://www.canva.com/folder/FAF2lZtloor"
    },
    "share": {
      "message": "Check this out!"
    }
  }
}
JSON