Skip navigation
Skip to main content
Webhook notifications
Collaborating
Webhook notifications

Folder access requested notifications

The NotificationContent sent when a user requests access to a folder.

If the type of notification is folder_access_requested, 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 requests access to a folder.

Properties of content
#typestring

The value for this can only be folder_access_requested.

#triggering_userTeamUser

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

Properties of triggering_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.

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

#folderFolder

The folder object, which contains metadata about the folder.

Properties of folder
#idstring

The folder ID.

#namestring

The folder name.

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

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

Example: Design access requested notification

{
  "id": "eb595730",
  "created_at": 1377396000,
  "content": {
    "type": "folder_access_requested",
    "triggering_user": {
      "user_id": "auDAbliZ2rQNNOsUl5OLu",
      "team_id": "Oi2RJILTrKk0KRhRUZozX",
      "display_name": "Jane 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,
      "thumbnail": {
        "width": 595,
        "height": 335,
        "url": "https://document-export.canva.com/Vczz9/zF9vzVtdADc/2/thumbnail/0001.png?<query-string>"
      }
    }
  }
}
json