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:
- An event occurs in Canva. For example, John comments on Jane's design.
- Canva sends the event information to the integration as a
POST
request. - The request contains event information, such as John's comment, when John made the comment, and what design it was made on.
- 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.
Scopes
If you want your integration to receive specific web notifications from Canva, enable the following scopes:
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:
comment
, see Comment.design_access_requested
, see Design access requested.design_approval_requested
, see Design approval requested.design_approval_response
, see Design approval response.design_approval_reviewer_invalidated
, see Design approval reviewer invalidated.design_mention
, see Design mention.folder_access_requested
, see Folder access requested.share_design
, see Share design.share_folder
, see Share folder.suggestion
, see Suggestion.team_invite
, see Team invite.