Skip navigation

Skip to main content

Webhook notifications
Collaborating
Webhook notifications

Webhooks

Receive real-time notification data for your users.

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.

Webhooks allow Canva to send real-time information to your integration, without polling or manual intervention. Your integration will receive webhooks for events relevant to the authenticated user. Here's how a webhook typically works:

  1. An event occurs in Canva. For example, John comments on Jane's design.
  2. Canva sends the event information to the integration as a POST request.
  3. The request contains event information, such as John's comment, when John made the comment, and what design it was made on.
  4. The integration receives the request, and sends a 200 status code back to Canva in response, which indicates the webhook was successfully received and processed (other status codes indicate an error).

When receiving requests, your integration can perform further actions based on the event information. For example, sending an auto-reply to John's comment.

Canva only supports outgoing webhooks. For information on responding to comments, check the Comments API documentation.

Scopes

If you want your integration to receive specific web notifications from Canva, enable the following scopes:

Notification type
Required scopes
Comments
  • collaboration:event
  • design:meta:read
  • comment:read
Design access requests
  • collaboration:event
  • design:meta:read
Design approvals
  • collaboration:event
  • design:meta:read
Design sharing events
  • collaboration:event
  • design:meta:read
Folder access requests
  • collaboration:event
  • folder:permission:write
Folder sharing events
  • collaboration:event
  • folder:read
Team access invitations
  • collaboration:event

When enabling and using scopes, you must be explicit.

For example, the asset:write scope doesn't grant asset:read permissions. To get both read and write permissions for assets, you must enable both scopes in your integration settings, and request both scopes during the authorization process.

Notification

A notification is generated once an event occurs in Canva. The webhook payload object consists of the required information about the event that has occurred.

The content depends on the type of the notification. For: