Skip navigation

Skip to main content

Webhook notifications
Collaborating
Webhook notifications

Design approval requested notifications

The NotificationContent sent when a user requests approval for 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.

If the type of notification is design_approval_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 a user to approve a design⁠(opens in a new tab or window).

Properties of content
typestring

The value for this can only be design_approval_requested.

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.

initial_requesting_userTeamUser

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

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

requested_groupsGroup[]

Metadata for the Canva Group, consisting of the Group ID, display name, and whether it's an external Canva Group.

Properties of requested_groups
idstring

The ID of the group with permissions to access the design.

externalboolean

Is the user making the API call (the authenticated user) and the Canva Group from different Canva Teams?

  • When true, the user and the group aren't in the same Canva Team.
  • When false, the user and the group are in the same Canva Team.
display_namestring
OPTIONAL

The display name of the group.

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.

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

view_urlstring

A temporary viewing URL for the design.

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.

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.

page_countinteger
OPTIONAL

The total number of pages in the design. Some design types don't have pages (for example, Canva docs).

approve_urlstring

A URL, which is scoped only to the user requested to review the design, that links to the design with the approval UI opened.

approval_requestApprovalRequestAction

Metadata about the design approval request.

Properties of approval_request
messagestring
OPTIONAL

The message included by the user when requesting a design approval.

Example: Design approval requested notification

{
  "id": "eb595730",
  "created_at": 1377396000,
  "content": {
    "type": "design_approval_requested",
    "triggering_user": {
      "id": "uKakKUfI03Fg8k2gZ6OkT",
      "display_name": "John Doe"
    },
    "initial_requesting_user": {
      "user_id": "auDAbliZ2rQNNOsUl5OLu",
      "team_id": "Oi2RJILTrKk0KRhRUZozX",
      "display_name": "Jane Doe"
    },
    "receiving_team_user": {
      "user_id": "auDAbliZ2rQNNOsUl5OLu",
      "team_id": "Oi2RJILTrKk0KRhRUZozX",
      "display_name": "Jane Doe"
    },
    "requested_groups": [
      {
        "id": "dl9n9SoWoExMsw6Ri1iTg",
        "display_name": "Sales team",
        "external": true
      }
    ],
    "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,
      "page_count": 3
    },
    "approve_url": "https://canva.com/api/action?token=HZb0lLHaEhNkT1qQrAwoe0-8SqyXUgJ4vnHGvN2rLZ0",
    "approval_request": {
      "message": "LGTM!"
    }
  }
}
JSON