Skip navigation
Skip to main content
Webhook notifications
Collaborating
Webhook notifications

Share folder notifications

The NotificationContent sent when a user shares a folder.

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
Optional

The folder ID.

#titlestring
Optional

The folder name, as shown in the Canva UI.

#urlstring
Optional

The folder URL.

#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",
      "title": "My awesome holiday",
      "url": "https://www.canva.com/folder/FAF2lZtloor"
    },
    "share": {
      "message": "Check this out!"
    }
  }
}
json